Listar membros de uma função de diretório
Namespace: microsoft.graph
Obtenha a lista de principais atribuídos à função de diretório.
Pode utilizar o ID de objeto e o ID de modelo do diretórioRole com esta API. O ID de modelo de uma função incorporada é imutável e pode ser visto na descrição da função no centro de administração do Microsoft Entra. Para obter detalhes, veja IDs de modelo de função.
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) | RoleManagement.Read.Directory | RoleManagement.ReadWrite.Directory, Directory.Read.All, Directory.ReadWrite.All |
Delegado (conta pessoal da Microsoft) | Sem suporte. | Sem suporte. |
Application | RoleManagement.Read.Directory | RoleManagement.ReadWrite.Directory, Directory.Read.All, Directory.ReadWrite.All |
Importante
Quando uma aplicação consulta uma relação que devolve uma coleção de tipo directoryObject , se não tiver permissão para ler um determinado tipo de recurso, os membros desse tipo são devolvidos, mas com informações limitadas. Por exemplo, apenas a propriedade @odata.type para o tipo de objeto e o ID é devolvido, enquanto outras propriedades são indicadas como null
. Com este comportamento, as aplicações podem pedir as permissões menos privilegiadas de que precisam, em vez de dependerem do conjunto de Diretórios.* permissões. Para obter mais detalhes, confira Informações limitadas retornadas para objetos membro inacessíveis.
Solicitação HTTP
Pode abordar a função de diretório com o respetivo ID ou roleTemplateId.
GET /directoryRoles/{role-id}/members
GET /directoryRoles(roleTemplateId='{roleTemplateId}')/members
Parâmetros de consulta opcionais
Este método suporta o $select
parâmetro de consulta OData para ajudar a personalizar a resposta. Devolve uma predefinição de 1000 objetos e não suporta a paginação com $top
.
Cabeçalhos de solicitação
Nome | Tipo | Descrição |
---|---|---|
Autorização | string | {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 uma coleção de objetos directoryObject no corpo da resposta.
Exemplos
Exemplo 1: Obter os membros de uma função de diretório com o ID da função
Solicitação
GET https://graph.microsoft.com/v1.0/directoryRoles/43a63cc2-582b-4d81-a79d-1591f91d5558/members
Resposta
Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.
HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"businessPhones":["000-000-0000"],
"displayName":"Adele Vance",
"givenName":"Adele",
"jobTitle":null,
"mail":"AdeleV@contoso.com",
"officeLocation":null,
"preferredLanguage":"en-US",
"surname":"Vance",
"userPrincipalName":"AdeleV@contoso.com"
}
]
}
Exemplo 2: obter os membros de uma função de diretório com roleTemplateId
Solicitação
GET https://graph.microsoft.com/v1.0/directoryRoles(roleTemplateId='43a63cc2-582b-4d81-a79d-1591f91d5558')/members
Resposta
Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.
HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"businessPhones":["000-000-0000"],
"displayName":"Adele Vance",
"givenName":"Adele",
"jobTitle":null,
"mail":"AdeleV@contoso.com",
"officeLocation":null,
"preferredLanguage":"en-US",
"surname":"Vance",
"userPrincipalName":"AdeleV@contoso.com"
}
]
}