Excluir um usuário

Namespace: microsoft.graph

Eliminar um objeto de utilizador .

Quando eliminados, os recursos do utilizador, incluindo a respetiva caixa de correio e atribuições de licenças, são movidos para um contentor temporário e, se o utilizador for restaurado no prazo de 30 dias, estes objetos são restaurados para os mesmos. O utilizador também é restaurado para todos os grupos de que era membro. Após 30 dias e se não for restaurado, o objeto de utilizador é eliminado permanentemente e os recursos atribuídos são libertados. Para gerir o objeto de utilizador eliminado, veja deletedItems.

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

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. 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.

Tipo de permissão	Permissões com menos privilégios	Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante)	User.ReadWrite.All	Indisponível.
Delegado (conta pessoal da Microsoft)	Sem suporte.	Sem suporte.
Aplicativo	User.ReadWrite.All	Indisponível.

Tem de ser atribuída ao utilizador de chamada, pelo menos, uma das seguintes funções do Microsoft Entra:

• Administrador do usuário
• Administrador de Autenticação Privilegiada

Para eliminar utilizadores com funções de administrador com privilégios em cenários delegados, tem de ser atribuída a permissão Directory.AccessAsUser.All delegated e o utilizador de chamada 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, a permissão User.ReadWrite.All application não é suficiente para eliminar utilizadores com funções administrativas com privilégios. A aplicação tem de ter uma função de administrador com privilégios superior, conforme indicado em Quem pode efetuar ações confidenciais.

Solicitação HTTP

DELETE /users/{id | userPrincipalName}

Cabeçalhos de solicitação

Cabeçalho	Valor
Autorização	{token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.

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 204 No Content. Não devolve nada no corpo da resposta.

Exemplo

Solicitação

O exemplo a seguir mostra uma solicitação.

HTTP

DELETE https://graph.microsoft.com/v1.0/users/{user-id}

C#

// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Users["{user-id}"].DeleteAsync();

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

CLI

mgc users delete --user-id {user-id}

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Ir

// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.Users().ByUserId("user-id").Delete(context.Background(), nil)

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

graphClient.users().byUserId("{user-id}").delete();

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

await client.api('/users/{user-id}')
	.delete();

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

PHP

<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$graphServiceClient->users()->byUserId('user-id')->delete()->wait();

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

PowerShell

Import-Module Microsoft.Graph.Users

Remove-MgUser -UserId $userId

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

await graph_client.users.by_user_id('user-id').delete()

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 204 No Content