Listar deletedItems (objetos de diretório)

Namespace: microsoft.graph

Recupere uma lista de objetos de diretório excluídos recentemente de itens excluídos. Os seguintes tipos são suportados:

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

A tabela a seguir mostra a permissão ou permissões menos privilegiadas necessárias para chamar essa API em cada tipo de recurso com suporte. Siga as práticas recomendadas para solicitar permissões com privilégios mínimos. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Recurso com suporte Delegada (conta corporativa ou de estudante) Delegada (conta pessoal da Microsoft) Application
administrativeUnit AdministrativeUnit.Read.All Sem suporte. AdministrativeUnit.Read.All
application Application.Read.All Sem suporte. Application.Read.All
agentIdentity AgentIdentity.Read.All Sem suporte. AgentIdentity.Read.All
agentIdentityBlueprint AgentIdentityBlueprint.Read.All Sem suporte. AgentIdentityBlueprint.Read.All
agentIdentityBlueprintPrincipal AgentIdentityBlueprintPrincipal.Read.All Sem suporte. AgentIdentityBlueprintPrincipal.Read.All
agentUser User.ReadBasic.All Sem suporte. User.ReadBasic.All
grupo Group.Read.All Sem suporte. Group.Read.All
servicePrincipal Application.Read.All Sem suporte. Application.Read.All
user User.Read.All Sem suporte. User.Read.All
certificateBasedAuthPki PublicKeyInfrastructure.Read.All Sem suporte. PublicKeyInfrastructure.Read.All
certificateAuthorityDetail PublicKeyInfrastructure.Read.All Sem suporte. PublicKeyInfrastructure.Read.All

Importante

Quando um aplicativo consulta uma relação que retorna uma coleção de tipos directoryObject , se ele não tiver permissão para ler um determinado tipo de recurso, membros desse tipo serão retornados, mas com informações limitadas. Por exemplo, somente a propriedade @odata.type para o tipo de objeto e a id são retornadas, enquanto outras propriedades são indicadas como null. Com esse comportamento, os aplicativos podem solicitar as permissões menos privilegiadas de que precisam, em vez de depender do conjunto de Diretório.* permissões. Para obter mais detalhes, confira Informações limitadas retornadas para objetos membro inacessíveis.

Solicitação HTTP

GET /directory/deletedItems/microsoft.graph.application
GET /directory/deletedItems/microsoft.graph.servicePrincipal
GET /directory/deletedItems/microsoft.graph.group
GET /directory/deletedItems/microsoft.graph.user
GET /directory/deletedItems/microsoft.graph.administrativeUnit
GET /directory/deletedItems/microsoft.graph.certificateBasedAuthPki
GET /directory/deletedItems/microsoft.graph.certificateAuthorityDetail

Importante

Para grupos de segurança excluídos temporariamente, a propriedade securityEnabled retorna false em vez de true devido a uma limitação conhecida.

Para identificar o tipo de grupo, use a propriedade groupTypes :

  • ["Unified"]indica um grupo do Microsoft 365.
  • Uma matriz vazia ([]) indica um grupo de segurança.

O tipo de conversão OData é uma parte necessária do URI e não há suporte para chamadas GET /directory/deletedItems sem um tipo.

Parâmetros de consulta opcionais

Esse método dá suporte aos parâmetros de consulta compatíveis com o recurso especificado pela conversão de OData. Ou seja, $count, $expand, $filter, $orderby$search, $select, e $top parâmetros de consulta. Essa API retorna 100 objetos por padrão e dá suporte ao retorno de até 999 objetos por página usando $top.

Algumas consultas são suportadas somente quando se usa o cabeçalho ConsistencyLevel definido como eventual e $count. Por exemplo:

https://graph.microsoft.com/v1.0/directory/deletedItems/microsoft.graph.group?&$count=true&$orderby=deletedDateTime desc&$select=id,displayName,deletedDateTime
ConsistencyLevel: eventual

Este exemplo requer o cabeçalho ConsistencyLevel porque os $orderby parâmetros de consulta and $count são usados na consulta.

$orderby Exemplos de parâmetros de consulta OData

O $orderby parâmetro de consulta OData tem suporte nas propriedades deletedDateTime, displayName e userPrincipalName dos tipos de objeto excluídos. Na propriedade deletedDateTime , a consulta requer a adição dos parâmetros de consulta avançados (cabeçalho ConsistencyLevel definido como eventual e $count=true cadeia de caracteres de consulta).

Conversão OData Propriedades que dão suporte a $orderby Exemplo
microsoft.graph.user deletedDateTime, displayName, userPrincipalName /directory/deletedItems/microsoft.graph.user?$orderby=userPrincipalName
microsoft.graph.group deletedDateTime, displayName /directory/deletedItems/microsoft.graph.group?$orderby=deletedDateTime asc&$count=true
Microsoft.Graph.Application deletedDateTime, displayName /directory/deletedItems/microsoft.graph.application?$orderby=displayName
Microsoft.Graph.Device deletedDateTime, displayName /directory/deletedItems/microsoft.graph.device?$orderby=deletedDateTime&$count=true

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Aceitar application/json

Corpo da solicitação

Não forneça um corpo de solicitação para esse método.

Resposta

Se bem-sucedido, este método retorna um código de resposta 200 OK e uma coleção de objetos directoryObject no corpo da resposta.

Exemplos

Exemplo 1: recuperar grupos excluídos

Solicitação

GET https://graph.microsoft.com/v1.0/directory/deletedItems/microsoft.graph.group

Resposta

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#groups",
  "value": [
    {
      "id":"46cc6179-19d0-473e-97ad-6ff84347bbbb",
      "displayName":"SampleGroup",
      "groupTypes":["Unified"],
      "mail":"example@contoso.com",
      "mailEnabled":true,
      "mailNickname":"Example",
      "securityEnabled":false,
      "visibility":"Public"
    }
  ]
}

Exemplo 2: recuperar a contagem de objetos de usuário excluídos e ordenar os resultados pela propriedade deletedDateTime

Solicitação

GET https://graph.microsoft.com/v1.0/directory/deletedItems/microsoft.graph.group?$count=true&$orderby=deletedDateTime asc&$select=id,displayName,deletedDateTime
ConsistencyLevel: eventual

Resposta

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#groups(id,displayName,deletedDateTime)",
    "@odata.count": 2,
    "value": [
        {
            "id": "c31799b8-0683-4d70-9e91-e032c89d3035",
            "displayName": "Role assignable group",
            "deletedDateTime": "2021-10-26T16:56:36Z"
        },
        {
            "id": "74e45ce0-a52a-4766-976c-7201b0f99370",
            "displayName": "Role assignable group",
            "deletedDateTime": "2021-10-26T16:58:37Z"
        }
    ]
}