Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
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.
Restaure um objeto de diretório recentemente eliminado a partir de itens eliminados. São suportados os seguintes tipos:
- administrativeUnit
- application
- agentIdentityBlueprint
- agentIdentity
- agentIdentityBlueprintPrincipal
- agentUser
- certificateBasedAuthPki
- certificateAuthorityDetail
- externalUserProfile
- group
- pendingExternalUserProfile
- servicePrincipal
- user
Se um item for eliminado acidentalmente, pode restaurar totalmente o item. Além disso, restaurar uma aplicação não restaura automaticamente o principal de serviço associado automaticamente. Tem de chamar esta API para restaurar explicitamente o principal de serviço eliminado.
Um item eliminado recentemente permanece disponível até 30 dias. Após 30 dias, esse item será excluído permanentemente.
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.ReadWrite.All | Sem suporte. | AdministrativeUnit.ReadWrite.All |
| application | Application.ReadWrite.All | Sem suporte. | Application.ReadWrite.OwnedBy |
| agentIdentity | AgentIdentity.DeleteRestore.All | Sem suporte. | AgentIdentity.DeleteRestore.All |
| agentIdentityBlueprint | AgentIdentityBlueprint.DeleteRestore.All | Sem suporte. | AgentIdentityBlueprint.DeleteRestore.All |
| agentIdentityBlueprintPrincipal | AgentIdentityBlueprintPrincipal.DeleteRestore.All | Sem suporte. | AgentIdentityBlueprintPrincipal.DeleteRestore.All |
| agentUser | AgentIdUser.ReadWrite.IdentityParentedBy | Sem suporte. | AgentIdUser.ReadWrite.IdentityParentedBy |
| certificateBasedAuthPki | PublicKeyInfrastructure.Read.All | Sem suporte. | PublicKeyInfrastructure.Read.All |
| certificateAuthorityDetail | PublicKeyInfrastructure.Read.All | Sem suporte. | PublicKeyInfrastructure.Read.All |
| externalUserProfile | ExternalUserProfile.ReadWrite.All | Sem suporte | ExternalUserProfile.ReadWrite.All |
| grupo | Group.ReadWrite.All | Sem suporte. | Group.ReadWrite.All |
| pendingExternalUserProfile | PendingExternalUserProfile.ReadWrite.All | Sem suporte | PendingExternalUserProfile.ReadWrite.All |
| servicePrincipal | Application.ReadWrite.All | Sem suporte. | Application.ReadWrite.OwnedBy |
| user | User.DeleteRestore.All | Sem suporte. | User.DeleteRestore.All |
Importante
Em cenários delegados com contas escolares ou profissionais, o utilizador com sessão iniciada tem de ter uma função de Microsoft Entra suportada ou uma função personalizada com uma permissão de função suportada. As seguintes funções com menos privilégios são suportadas para esta operação.
- Identidades do agente: Administrador de ID do Agente
- Unidades administrativas: Leitores de Diretórios (só de leitura), Leitores Globais (só de leitura), Administrador de Funções Com Privilégios
- Aplicações: Administrador de Identidade Híbrida, Administrador de Aplicações na Cloud, Administrador de Aplicações
- Perfis de utilizador externos: Leitor Global (só de leitura), Administrador Skype for Business, Administrador do Teams
- Grupos: Administrador de Grupos (exceto grupos atribuíveis a funções), Administrador de Utilizadores (exceto grupos atribuíveis a funções), Administrador de Função Privilegiada (função com menos privilégios para grupos atribuíveis a funções)
- Perfis de utilizador externos pendentes: Leitor Global (só de leitura), Administrador Skype for Business, Administrador do Teams
- Principais de serviço: Administrador de Identidade Híbrida, Administrador de Aplicações na Cloud, Administrador de Aplicações
- Utilizadores: Administrador de Autenticação, Administrador de Autenticação Privilegiada, Administrador de Utilizadores. No entanto, para restaurar utilizadores com funções de administrador com privilégios:
- Em cenários delegados, a aplicação tem de ter a permissão Directory.AccessAsUser.All delegated e o utilizador de chamada também tem de ter uma função de administrador com privilégios superior, conforme indicado em Quem pode realizar ações confidenciais?.
- Em cenários apenas de aplicações e para além de lhe ser concedida a permissão de aplicação User.ReadWrite.All , a aplicação tem de ter uma função de administrador com privilégios superior, conforme indicado em Quem pode realizar ações confidenciais?.
Solicitação HTTP
POST /directory/deleteditems/{id}/restore
Cabeçalhos de solicitação
| Nome | Descrição |
|---|---|
| Autorização | {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização. |
| Content-type | application/json |
Corpo da solicitação
No corpo do pedido, forneça uma representação JSON dos parâmetros.
A tabela seguinte lista os parâmetros que são necessários quando chama esta ação.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| autoReconcileProxyConflict | Booliano | Parâmetro opcional. Indica se Microsoft Entra ID deve remover quaisquer endereços proxy em conflito ao restaurar um utilizador eliminado de forma recuperável cujos endereços proxy são atualmente utilizados para um utilizador ativo. Utilizado apenas para restaurar utilizadores eliminados de forma recuperável. O valor predefinido para este paramater é false. |
| newUserPrincipalName | Cadeia de caracteres | O novo userPrincipalName a adicionar ao utilizador restaurado. Opcional. |
Resposta
Se bem-sucedido, este método retorna um código de resposta 200 OK e um objeto directoryObject no corpo da resposta.
Exemplos
Exemplo 1: Restaurar um objeto de diretório eliminado
Solicitação
POST https://graph.microsoft.com/beta/directory/deleteditems/46cc6179-19d0-473e-97ad-6ff84347bbbb/restore
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#directoryObjects/$entity",
"@odata.type":"#microsoft.graph.group",
"id":"46cc6179-19d0-473e-97ad-6ff84347bbbb",
"displayName":"SampleGroup",
"groupTypes":["Unified"],
"mail":"example@contoso.com",
"mailEnabled":true,
"mailNickname":"Example",
"securityEnabled":false,
"visibility":"Public"
}
Exemplo 2: Restaurar um utilizador eliminado e remover endereços proxy em conflito
Solicitação
POST https://graph.microsoft.com/beta/directory/deleteditems/78bf875b-9343-4edc-9130-0d3958113563/restore
Content-Type: application/json
{
"autoReconcileProxyConflict": true
}
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#users/$entity",
"@odata.type": "#microsoft.graph.user",
"id": "78bf875b-9343-4edc-9130-0d3958113563",
"businessPhones": [],
"displayName": "SampleUser",
"givenName": "Sample",
"jobTitle": "Product Marketing Manager",
"mail": "sampleuser@contoso.com",
"mobilePhone": "+1 425 555 0109",
"officeLocation": "18/2111",
"preferredLanguage": "en-US",
"surname": "Vance",
"userPrincipalName": "sampleuser@contoso.com"
}
Exemplo 3: Restaurar um utilizador eliminado e atribuir-lhe um novo userPrincipalName
Solicitação
POST https://graph.microsoft.com/beta/directory/deleteditems/78bf875b-9343-4edc-9130-0d3958113563/restore
Content-Type: application/json
{
"newUserPrincipalName": "johndoe@contoso.com"
}
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#directoryObjects/$entity",
"@odata.type": "#microsoft.graph.user",
"id": "78bf875b-9343-4edc-9130-0d3958113563",
"businessPhones": [],
"displayName": "SampleUser",
"givenName": "Sample",
"mobilePhone": "+1 425 555 0109",
"officeLocation": "18/2111",
"preferredLanguage": "en-US",
"surname": "Vance",
"userPrincipalName": "johndoe@contoso.com"
}