Listar deletedItems (objetos de diretório)
Namespace: microsoft.graph
Importante
As APIs na versão /beta
no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.
Obtenha uma lista de objetos de diretório eliminados recentemente de itens eliminados. São suportados os seguintes tipos:
- administrativeUnit
- application
- certificateBasedAuthPki
- [certificateAuthorityDetail](.. /resources/certificateauthoritydetail.md
- externalUserProfile
- group
- pendingExternalUserProfile
- servicePrincipal
- user
Nota: Os grupos de segurança eliminados são eliminados permanentemente e não podem ser obtidos através desta API.
Esta API está disponível nas seguintes implementações de cloud nacionais.
Serviço global | US Government L4 | US Government L5 (DOD) | China operada pela 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Permissões
A tabela seguinte mostra as permissões ou permissões com menos privilégios necessárias para chamar esta API em cada tipo de recurso suportado. Siga as melhores práticas para pedir permissões com menos privilégios. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja 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 |
externalUserProfile | ExternalUserProfile.Read.All | Sem suporte | ExternalUserProfile.Read.All |
grupo | Group.Read.All | Sem suporte. | Group.Read.All |
pendingExternalUserProfile | PendingExternalUserProfile.Read.All | Sem suporte | PendingExternalUserProfile.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 uma aplicação consulta uma relação que devolve uma coleção de tipo directoryObject , se não tiver permissão para ler um determinado tipo de recurso, os membros desse tipo são devolvidos, mas com informações limitadas. Por exemplo, apenas a propriedade @odata.type para o tipo de objeto e o ID é devolvido, enquanto outras propriedades são indicadas como null
. Com este comportamento, as aplicações podem pedir as permissões menos privilegiadas de que precisam, em vez de dependerem do conjunto de Diretórios.* 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.externalUserProfile
GET /directory/deletedItems/microsoft.graph.pendingExternalUserProfile
GET /directory/deletedItems/microsoft.graph.certificateBasedAuthPki
GET /directory/deletedItems/microsoft.graph.certificateAuthorityDetail
O tipo de conversão OData é uma parte necessária do URI e a chamada GET /directory/deleteditems
sem um tipo não é suportada.
Parâmetros de consulta opcionais
Este método suporta os parâmetros de consulta suportados pelo recurso especificado pela conversão de OData. Ou seja, , $count
, $filter
$expand
, $orderby
, $search
e $select
parâmetros $top
de consulta. Esta API devolve 100 objetos por predefinição e suporta a devolução de até 999 objetos por página com $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/beta/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 e $count
são utilizados na consulta.
$orderby exemplos de parâmetros de consulta OData
O $orderby
parâmetro de consulta OData é suportado nas propriedades deletedDateTime, displayName e userPrincipalName dos tipos de objeto eliminados. 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 consulta).
Cast OData | Propriedades que suportam $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: Obter grupos eliminados
Solicitação
GET https://graph.microsoft.com/beta/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/beta/$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: Obter a contagem de objetos de utilizador eliminados e ordenar os resultados pela propriedade deletedDateTime
Solicitação
GET https://graph.microsoft.com/beta/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/beta/$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"
}
]
}