Partilhar via

Listar membros

  • 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.

Utilize esta API para obter a lista de membros (utilizadores, grupos e dispositivos) numa unidade administrativa.

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) 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

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.

Observação

Para ver os membros com uma associação oculta numa unidade administrativa, a aplicação tem de ter a permissão delegada ou aplicação Membro.Read.Hidden .

Importante

Em cenários delegados com contas escolares ou profissionais, o utilizador com sessão iniciada tem de ser um utilizador membro ou ser-lhe atribuída uma função de Microsoft Entra suportada ou uma função personalizada com uma permissão de função suportada. As seguintes funções com menos privilégios são suportadas para esta operação.

  • Leitores de Diretórios – Ler propriedades básicas e membros de unidades administrativas
  • Leitor Global – Ler todas as propriedades das unidades administrativas, incluindo membros
  • Administrador de Funções Com Privilégios – faça a gestão total de unidades administrativas, incluindo membros, mas excluindo unidades administrativas restritas. Para obter mais informações, veja Unidades administrativas de gestão restrita no Microsoft Entra ID

Solicitação HTTP

GET /administrativeUnits/{id}/members
GET /administrativeUnits/{id}/members/$ref

Parâmetros de consulta opcionais

Este método (quando utilizado sem $ref) suporta os $searchparâmetros de consulta ,$counte $filter OData para ajudar a personalizar a resposta. A conversão de OData também está ativada. Por exemplo, pode transmitir para obter apenas os utilizadores que são membros da unidade administrativa.

$search é suportado apenas nas propriedades displayName e description . A utilização de parâmetros de consulta com esta API é suportada apenas com parâmetros de consulta avançados. Para obter mais informações, veja Capacidades avançadas de consulta em objetos de diretório.

Cabeçalhos de solicitação

Cabeçalho Valor
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 a utilização de ConsistencyLevel e $count, veja Advanced query capabilities on directory objects (Capacidades de consulta avançadas 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, este método devolve um 200 OK código de resposta e uma coleção de objetos de utilizador, grupo ou dispositivo no corpo da resposta. A adição $ref no final do pedido devolve uma coleção de apenas @odata.id URLs dos membros.

Exemplos

Exemplo 1: Listar objetos de membro

Solicitação

O pedido seguinte listará os membros da unidade administrativa, devolvendo uma coleção de utilizadores e/ou grupos.

GET https://graph.microsoft.com/beta/administrativeUnits/{id}/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

{
  "value":[
    {
      "@odata.type":"#microsoft.graph.user",
      "id":"492c5308-59fd-4740-9c83-4b3db07a6d70"
      "accountEnabled":true,
      "businessPhones":[],
      "companyName":null,
      "displayName":"Demo User"
    },
    {
      "@odata.type":"#microsoft.graph.group",
      "id":"07eaa5c7-c9b6-45cf-8ff7-3147d5122caa",
      "description":"This group is the best ever",
      "displayName":"Awesome group"
    }
  ]
}

Exemplo 2: Listar referências de membros

Solicitação

O pedido seguinte listará as referências de membros da unidade administrativa, devolvendo uma coleção de @odata.id referências aos membros.

GET https://graph.microsoft.com/beta/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/beta/directoryObjects/492c5308-59fd-4740-9c83-4b3db07a6d70"
    },
    {
      "@odata.id": "https://graph.microsoft.com/beta/directoryObjects/07eaa5c7-c9b6-45cf-8ff7-3147d5122caa"
    }
  ]
}