Share via

Obter directoryRole

  • Artigo

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.

Recupere as propriedades de um objeto directoryRole.

Você pode usar a ID do objeto e a ID do modelo do diretórioRole com essa API. A ID do modelo de uma função interna é imutável e pode ser vista na descrição da função no centro de administração do Microsoft Entra. Para obter detalhes, consulte IDs de modelo de função.

Essa API está disponível nas seguintes implantações nacionais de nuvem.

Serviço global Governo dos EUA L4 GOVERNO DOS EUA L5 (DOD) China operada pela 21Vianet
✅ ✅ ✅ ✅

Permissões

Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas 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 privilegiadas mais altas
Delegado (conta corporativa ou de estudante) RoleManagement.Read.Directory Directory.Read.All, Directory.ReadWrite.All, RoleManagement.ReadWrite.Directory
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Aplicativo RoleManagement.Read.Directory Directory.Read.All, Directory.ReadWrite.All, RoleManagement.ReadWrite.Directory

Para cenários delegados, o usuário de chamada deve ser um usuário membro ou ter pelo menos uma das seguintes funções de Microsoft Entra:

  • Administrador do usuário
  • Administrador da Assistência Técnica
  • Administrador do Suporte de Serviços
  • Administrador de Cobrança
  • Usuário
  • Administrador de caixa de correio
  • Leitores de Diretório
  • Escritores de diretório
  • Administrador de Aplicativos
  • Leitor de segurança
  • Administrador de Segurança
  • Administrador de Função Privilegiada
  • Administrador de Aplicativos de Nuvem
  • Aprovador de acesso do Customer LockBox
  • Administrador do Dynamics 365
  • Administrador do Power BI
  • Administrador do Azure Proteção de Informações
  • Administrador Análise de Área de Trabalho
  • Administrador de Licenças
  • Administrador da Área de Trabalho Gerenciada da Microsoft
  • Administrador de Autenticação
  • Administrador de Autenticação Privilegiada
  • Administrador de Comunicações do Teams
  • Engenheiro de Suporte de Comunicações de Equipes
  • Especialista em suporte à comunicação de equipes
  • Administrador do Teams
  • Insights do Administrador
  • Administrador de Dados de Conformidade
  • Operador de Segurança
  • Administrador kaizala
  • Leitor Global
  • Usuário do Business Center de Licenciamento de Volume
  • Usuário do Centro de Serviço de Licenciamento de Volume
  • Administrador do Comércio Moderno
  • Microsoft Store para Empresas Usuário
  • Revisor de Diretório

Solicitação HTTP

Você pode abordar a função de diretório usando sua id ou roleTemplateId.

GET /directoryRoles/{role-id}
GET /directoryRoles(roleTemplateId='{roleTemplateId}')

Parâmetros de consulta opcionais

Esse método dá suporte ao $selectparâmetro de consulta OData para ajudar a personalizar a resposta.

Cabeçalhos de solicitação

Nome Descrição
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 200 OK e um objeto directoryRole no corpo da resposta.

Exemplos

Exemplo 1: obter a definição de uma função de diretório usando a ID da função

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/directoryRoles/fe8f10bf-c9c2-47eb-95cb-c26cc85f1830

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#directoryRoles/$entity",
    "id": "fe8f10bf-c9c2-47eb-95cb-c26cc85f1830",
    "deletedDateTime": null,
    "description": "Can read basic directory information. Commonly used to grant directory read access to applications and guests.",
    "displayName": "Directory Readers",
    "roleTemplateId": "88d8e3e3-8f55-4a1e-953a-9b9898b8876b"
}

Exemplo 2: Obter a definição de uma função de diretório usando roleTemplateId

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/directoryRoles(roleTemplateId='88d8e3e3-8f55-4a1e-953a-9b9898b8876b')

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#directoryRoles/$entity",
    "id": "fe8f10bf-c9c2-47eb-95cb-c26cc85f1830",
    "deletedDateTime": null,
    "description": "Can read basic directory information. Commonly used to grant directory read access to applications and guests.",
    "displayName": "Directory Readers",
    "roleTemplateId": "88d8e3e3-8f55-4a1e-953a-9b9898b8876b"
}