Listar membros
Namespace: microsoft.graph
Use essa API para obter a lista de membros (usuários, grupos ou dispositivos) em uma unidade administrativa.
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) | AdministrativeUnit.Read.All | AdministrativeUnit.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
Delegado (conta pessoal da Microsoft) | Sem suporte. | Sem suporte. |
Application | AdministrativeUnit.Read.All | AdministrativeUnit.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All |
Observação: para listar os membros de uma associação oculta em uma unidade administrativa, a permissão Member.Read.Hidden é necessária.
Quando um aplicativo consulta uma relação que retorna uma coleção de tipos directoryObject , se não tiver permissão para ler um determinado tipo derivado (como dispositivo), os membros desse tipo serão retornados, mas com informações limitadas. Com esse comportamento, os aplicativos podem solicitar as permissões menos privilegiadas de que precisam, em vez de depender do conjunto de Diretório.*Permissões. Para obter mais detalhes, confira Informações limitadas retornadas para objetos membro inacessíveis.
Solicitação HTTP
GET /directory/administrativeUnits/{id}/members
GET /directory/administrativeUnits/{id}/members/$ref
Parâmetros de consulta opcionais
Esse método (quando usado sem $ref
) dá suporte aos parâmetros de consulta OData para ajudar a personalizar a resposta, incluindo $search
, $count
e $filter
. O OData cast também está habilitado, por exemplo, você pode lançar para obter apenas os usuários que são membros da unidade administrativa.
$search
há suporte apenas nas propriedades displayName e description . Algumas consultas são suportadas somente quando se usa o cabeçalho ConsistencyLevel definido como eventual
e $count
. Para obter mais informações, consulte Recursos avançados de consulta em objetos de diretório.
Cabeçalhos de solicitação
Nome | Descrição |
---|---|
Autorização | {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização. |
ConsistencyLevel | eventualmente. Este cabeçalho e $count são necessários quando se utiliza $search , ou em uso específico de $filter . Para obter mais informações sobre o uso de ConsistencyLevel e $count , consulte Recursos avançados de consulta em objetos de diretório. |
Corpo da solicitação
Não forneça um corpo de solicitação para esse método.
Resposta
Se for bem-sucedido, esse método retornará um 200 OK
código de resposta e uma coleção de objetos de usuário, grupo ou dispositivo no corpo da resposta. Adicionar $ref
no final da solicitação retorna uma coleção de apenas @odata.id
URLs dos membros.
Exemplos
Exemplo 1: Listar objetos membro
Solicitação
A solicitação a seguir listará os membros da unidade administrativa, retornando uma coleção de usuários, grupos e dispositivos.
GET https://graph.microsoft.com/v1.0/directory/administrativeUnits/8a07f5a8-edc9-4847-bbf2-dde106594bf4/members
Resposta
O exemplo a seguir mostra a 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/v1.0/$metadata#directoryObjects",
"value": [
{
"@odata.type": "#microsoft.graph.device",
"id": "7c06cd31-7c30-4f3b-a5c3-444cd8dd63ac",
"accountEnabled": true,
"deviceId": "6fa60d52-01e7-4b18-8055-4759461fc16b",
"displayName": "Test Windows device",
"operatingSystem": "Windows"
},
{
"@odata.type": "#microsoft.graph.device",
"id": "c530e1f6-7b4c-4313-840e-cf1a99ec3b38",
"accountEnabled": false,
"deviceId": "4c299165-6e8f-4b45-a5ba-c5d250a707ff",
"displayName": "Test Linux device",
"operatingSystem": "linux"
}
]
}
Exemplo 2: Referências de membro de lista
Solicitação
A solicitação a seguir listará as referências de membro da unidade administrativa, retornando uma coleção de @odata.id
referências aos membros.
GET https://graph.microsoft.com/v1.0/directory/administrativeUnits/{id}/members/$ref
Resposta
O exemplo a seguir mostra a resposta.
Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.
HTTP/1.1 200 OK
Content-type: application/json
{
"value":[
{
"@odata.id": "https://graph.microsoft.com/v1.0/directoryObjects/492c5308-59fd-4740-9c83-4b3db07a6d70"
},
{
"@odata.id": "https://graph.microsoft.com/v1.0/directoryObjects/07eaa5c7-c9b6-45cf-8ff7-3147d5122caa"
}
]
}
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de