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.
Devolver todos os IDs de grupo para os grupos dos quais o utilizador, grupo, principal de serviço, contacto organizacional, dispositivo ou objeto de diretório especificado é membro. Esta função é transitiva.
Esta API devolve até 11 000 IDs de grupo. Se estiverem disponíveis mais de 11 000 resultados, devolve um 400 Bad Request
erro com o Directory_ResultSizeLimitExceeded
código de erro. Se receber o Directory_ResultSizeLimitExceeded
código de erro, utilize o grupo Listar membro transitivoAPI .
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
Uma das seguintes permissões é necessária para chamar esta API. Para saber mais, incluindo como escolher permissões, confira Permissões.
Associações a grupos para um objeto de diretório
Aqui, a permissão permite-lhe ler qualquer objeto de diretório, independentemente do tipo de objeto. Para definir o âmbito da operação para um tipo de objeto específico e utilizar permissões com privilégios menores, veja 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 a grupos para um utilizador
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 a grupos de 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 a grupos para um principal 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 a grupos para um contacto 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 a grupos para um dispositivo
Tipo de permissão | Permissões com menos privilégios | Permissões com privilégios superiores |
---|---|---|
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.ReadWrite.All, GroupMember.Read.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.ReadWrite.All, GroupMember.Read.All, User.Read.All |
Solicitação HTTP
Associações a grupos para um objeto de diretório (utilizador, grupo, principal de serviço ou contacto organizacional).
POST /directoryObjects/{id}/getMemberGroups
Associações a grupos para o utilizador com sessão iniciada ou outros utilizadores.
POST /me/getMemberGroups
POST /users/{id | userPrincipalName}/getMemberGroups
Associações a grupos de um grupo.
POST /groups/{id}/getMemberGroups
Associações a grupos para um principal de serviço.
POST /servicePrincipals/{id}/getMemberGroups
Associações a grupos para um contacto organizacional.
POST /contacts/{id}/getMemberGroups
Associações a grupos 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 devolvidos; false para especificar que todos os grupos e funções de diretório de que a entidade é membro devem ser devolvidos.
true só podem ser especificados para os utilizadores ou principais de serviço devolverem grupos com segurança ativada. |
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 as associações a grupos de 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 as associações a grupos do utilizador com sessão iniciada
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"
]
}