tipo de recurso directoryRole

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.

Observação

A Microsoft recomenda que utilize a API RBAC unificada em vez desta API. A API RBAC unificada proporciona mais funcionalidade e flexibilidade. Para obter mais informações, veja unifiedRoleDefinition resource type (Tipo de recurso unifiedRoleDefinition).

Representa uma função de diretório Microsoft Entra. Microsoft Entra funções de diretório também são conhecidas como funções de administrador. Para obter mais informações sobre as funções de diretório (administrador), veja Assigning administrator roles in Microsoft Entra ID (Atribuir funções de administrador no Microsoft Entra ID). Com o Microsoft Graph, você pode atribuir usuários a funções de diretório para conceder a eles as permissões da função de destino. Para ler uma função de diretório ou atualizar seus membros, primeiro ela deve ser ativada no locatário. Apenas a função de diretório Administradores de Empresa é ativada por padrão. Para ativar outras funções de diretório disponíveis, envie um pedido POST com o ID do diretórioRoleTemplate no qual se baseia a função de diretório. Liste modelos de função de diretório para ter todas as outras funções de diretório disponíveis. Herda de directoryObject.

Por predefinição, as funções de diretório estão confinadas para serem ao nível do inquilino. No entanto, as funções de diretório (atualmente apenas o administrador da conta de utilizador e o administrador de suporte técnico) também podem ser confinadas a unidades administrativas.

Esse recurso permite:

• Usar a consulta delta para controlar adições, exclusões e atualizações incrementais oferecendo uma função delta.

Métodos

Método	Tipo de retorno	Descrição
Obter função de diretório	directoryRole	Leia as propriedades e os relacionamentos do objeto directoryRole.
Listar funções de diretório	Coleção directoryRole	Lista as funções de diretório ativadas no locatário.
Adicionar membro	directoryObject	Adicione um usuário à função de diretório postando na propriedade de navegação de membros.
Listar membros	Coleção directoryObject	Obtenha os usuários que são membros da função directory da propriedade de navegação members.
Remover membro	directoryObject	Remova um usuário da função de diretório.
Ativar a função de diretório	directoryRole	Ative uma função de diretório.
Listar membros no âmbito	Coleção scopedRoleMembership	Liste os membros desta função de diretório que têm como escopo as unidades administrativas, por meio da coleção de recursos scopedRoleMembership.
Obter delta	Coleção directoryRole	Obtenha alterações incrementais para as funções de diretório.

Propriedades

Propriedade	Tipo	Descrição
description	Cadeia de caracteres	A descrição da função de diretório. Somente leitura. Suporta $filter (eq), $search, $select.
displayName	Cadeia de caracteres	O nome de exibição da função de diretório. Somente leitura. Suporta $filter (eq), $search, $select.
id	Cadeia de caracteres	O identificador exclusivo da função de diretório. Herdado de directoryObject. Chave, Não Anulável, Somente Leitura. Suporta $filter (eq), $select.
roleTemplateId	String	A id do directoryRoleTemplate em que esta função se baseia. A propriedade deve ser especificada ao ativar uma função de diretório em um locatário com uma operação POST. Depois que a função directory tiver sido ativada, a propriedade será somente leitura. Suporta $filter (eq), $select.

Relações

Relação	Tipo	Descrição
membros	Coleção directoryObject	Usuários que são membros desta função de diretório. Métodos HTTP: GET, POST, DELETE. Somente leitura. Anulável. Suporta o $expand.
scopedMembers	Coleção scopedRoleMembership	Membros desta função de diretório que têm como escopo unidades administrativas. Somente leitura. Anulável.

Representação JSON

A representação JSON seguinte mostra o tipo de recurso.

{
  "description": "string",
  "displayName": "string",
  "id": "string (identifier)",
  "roleTemplateId": "string"
}