Ativar directoryRole

Namespace: microsoft.graph

Ative uma função de diretório. Para ler uma função de diretório ou atualizar seus membros, primeiro ela deve ser ativada no locatário.

As funções de Administradores da Empresa e as funções implícitas do diretório de usuários (funções Usuário, Usuário Convidado e Usuário Convidado Restrito ) são ativadas por padrão. Para acessar e atribuir membros a outras funções de diretório, primeiro você deve ativá-lo com a ID do modelo de função de diretório correspondente.

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

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. 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.

Tipo de permissão Permissões menos privilegiadas Permissões com privilégios mais elevados
Delegado (conta corporativa ou de estudante) RoleManagement.ReadWrite.Directory Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application RoleManagement.ReadWrite.Directory Indisponível.

Importante

Para acesso delegado usando contas corporativas ou de estudante, o usuário conectado deve receber uma função do Microsoft Entra com suporte ou uma função personalizada que conceda as permissões necessárias para esta operação. O Administrador de Função Privilegiada é a função com menos privilégios com suporte para esta operação.

Solicitação HTTP

POST /directoryRoles

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 da solicitação, forneça uma representação JSON do objeto directoryRole.

A tabela a seguir mostra as propriedades que são necessárias ao ativar uma função de diretório.

Parâmetro Tipo Descrição
roleTemplateId string Obrigatório. A ID do directoryRoleTemplate em que a função se baseia. Esta é a única propriedade que pode ser especificada na solicitação.

Resposta

Se bem-sucedido, este método retorna um código de resposta 201 Created e um objeto directoryRole no corpo da resposta.

Exemplo

Solicitação

POST https://graph.microsoft.com/v1.0/directoryRoles
Content-type: application/json

{
  "roleTemplateId": "fe930be7-5e62-47db-91af-98c3a49a38b1"
}

No corpo da solicitação, forneça uma representação JSON do objeto directoryRole.

Resposta

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

HTTP/1.1 201 Created
Content-type: application/json

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#directoryRoles/$entity",
  "id": "76f84d30-2759-4c66-915d-65c6e4083fa0",
  "deletedDateTime": null,
  "description": "Can manage all aspects of users and groups, including resetting passwords for limited admins.",
  "displayName": "User Administrator",
  "roleTemplateId": "fe930be7-5e62-47db-91af-98c3a49a38b1"
}