directoryObject: getMemberGroups

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.

Retorne todas as IDs de grupo para os grupos dos quais o usuário, grupo, entidade de serviço, contato organizacional, dispositivo ou objeto de diretório especificado é membro. Esta função é transitiva.

Essa API retorna até 11.000 IDs de grupo. Se mais de 11.000 resultados estiverem disponíveis, ele retornará um 400 Bad Request erro com o código de Directory_ResultSizeLimitExceeded erro. Se você receber o Directory_ResultSizeLimitExceeded código de erro, use a API List group transitive memberOf .

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

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Uma das seguintes permissões é necessária para chamar esta API. Para saber mais, incluindo como escolher permissões, confira Permissões.

Associações de grupo para um objeto de diretório

Aqui, a permissão permite que você leia qualquer objeto de diretório, independentemente do tipo de objeto. Para definir o escopo da operação para um tipo de objeto específico e usar permissões com privilégios menores, consulte outras tabelas de permissões nesta página.

Tipo de permissão Permissões (da com menos para a com mais privilégios)
Delegado (conta corporativa ou de estudante) Directory.Read.All
Delegado (conta pessoal da Microsoft) Sem suporte.
Aplicativo Directory.Read.All

Associações de grupo para um usuário

Tipo de permissão Permissões (da com menos para a com mais privilégios)
Delegado (conta corporativa ou de estudante) User.ReadBasic.All e GroupMember.Read.All, User.Read.All e GroupMember.Read.All, User.ReadBasic.All e Group.Read.All, User.Read.All e Group.Read.All, Directory.Read.All
Delegado (conta pessoal da Microsoft) Sem suporte.
Application User.ReadBasic.All e GroupMember.Read.All, User.Read.All e GroupMember.Read.All, User.ReadBasic.All e Group.Read.All, User.Read.All e Group.Read.All, Directory.Read.All

Associações de grupo para um grupo

Tipo de permissão Permissões (da com menos para a com mais privilégios)
Delegada (conta corporativa ou de estudante) GroupMember. Read. All, Group. Read. All, Directory. Read. All, Group. ReadWrite. All, Directory. ReadWrite. All
Delegada (conta pessoal da Microsoft) Sem suporte.
Aplicativo GroupMember. Read. All, Group. Read. All, Directory. Read. All, Group. ReadWrite. All, Directory. ReadWrite. All

Associações de grupo para uma entidade de serviço

Tipo de permissão Permissões (da com menos para a com mais privilégios)
Delegado (conta corporativa ou de estudante) Application.Read.All, Directory.Read.All, Application.ReadWrite.All, Directory.ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte.
Aplicativo Application.Read.All, Directory.Read.All, Application.ReadWrite.All, Directory.ReadWrite.All

Associações de grupo para um contato organizacional

Tipo de permissão Permissões (da com menos para a com mais privilégios)
Delegado (conta corporativa ou de estudante) Directory.Read.All, Directory.ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte.
Aplicativo Directory.Read.All, Directory.ReadWrite.All

Associações de grupo para um dispositivo

Tipo de permissão Permissões menos privilegiadas Permissões com privilégios mais elevados
Delegado (conta corporativa ou de estudante) Application.Read.All Application.ReadWrite.All, Device.Read.All, Directory.Read.All, Directory.ReadWrite.All, Group.Read.All, Group.ReadBasic.All, Group.ReadWrite.All, GroupMember.Read.All, GroupMember.ReadBasic.All, User.Read.All
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application Application.Read.All Application.ReadWrite.All, Device.Read.All, Device.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All, Group.Read.All, Group.ReadBasic.All, Group.ReadWrite.All, GroupMember.Read.All, GroupMember.ReadBasic.All, User.Read.All

Solicitação HTTP

Associações de grupo para um objeto de diretório (usuário, grupo, entidade de serviço ou contato organizacional).

POST /directoryObjects/{id}/getMemberGroups

Associações de grupo para o usuário conectado ou outros usuários.

POST /me/getMemberGroups
POST /users/{id | userPrincipalName}/getMemberGroups

Associações de grupo para um grupo.

POST /groups/{id}/getMemberGroups

Associações de grupo para uma entidade de serviço.

POST /servicePrincipals/{id}/getMemberGroups

Associações de grupo para um contato organizacional.

POST /contacts/{id}/getMemberGroups

Associações de grupo para um dispositivo.

POST /devices/{id}/getMemberGroups

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json

Corpo da solicitação

Forneça um objeto JSON com os seguintes parâmetros no corpo da solicitação.

Parâmetro Tipo Descrição
securityEnabledOnly Booliano true para especificar que apenas os grupos de segurança dos quais a entidade é membro devem ser retornados; false para especificar que todos os grupos e funções de diretório dos quais a entidade é membro devem ser retornados. true Pode ser especificado apenas para que usuários ou entidades de serviço retornem grupos habilitados para segurança.

Resposta

Se bem-sucedido, este método retorna o código de resposta 200 OK e o objeto da coleção de cadeias de caracteres no corpo da resposta.

Exemplos

Exemplo 1: verificar associações de grupo para um objeto de diretório

Solicitação

POST https://graph.microsoft.com/beta/directoryObjects/0049d944-a805-4680-9f54-3ab292090309/getMemberGroups
Content-type: application/json

{
    "securityEnabledOnly": false
}

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/beta/$metadata#Collection(Edm.String)",
    "value": [
        "a8daa1fb-d24c-47d0-9e9e-c99e83394e3e"
    ]
}

Exemplo 2: Verificar associações de grupo para o usuário conectado

Solicitação

POST https://graph.microsoft.com/beta/me/getMemberGroups
Content-type: application/json

{
  "securityEnabledOnly": true
}

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#Collection(Edm.String)",
    "value": [
        "6239671a-0db6-4e8b-9d2f-f280efb5a181",
        "2e2f1227-1586-45ae-bf51-fccc1de72625",
        "f5987b5a-61f6-4c31-9fa2-7bfb845c8d2a"
    ]
}