Obter administrativeUnit
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.
Obtenha as propriedades e relações de um objeto administrativeUnit .
Uma vez que o recurso administrativeUnit suporta extensões, também pode utilizar a GET
operação para obter propriedades personalizadas e dados de extensão numa instância administrativeUnit .
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
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}
GET /directory/administrativeUnits/{id}
Parâmetros de consulta opcionais
Este método suporta o $select
parâmetro de consulta OData para ajudar a personalizar a resposta. As propriedades da extensão também suportam parâmetros de consulta da seguinte forma:
Tipo de extensão | Comentários |
---|---|
Extensões de esquema | Retornado somente com $select . Suporta $filter (eq ). |
Extensões de diretório | Retornado por padrão. Suporta $filter (eq ). |
Cabeçalhos de solicitação
Nome | Descrição |
---|---|
Autorização | {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 for bem-sucedido, este método devolve um 200 OK
código de resposta e um objeto administrativeUnit no corpo da resposta.
Exemplos
Exemplo 1: Obter uma unidade administrativa
Solicitação
GET https://graph.microsoft.com/beta/administrativeUnits/4d7ea995-bc0f-45c0-8c3e-132e93bf95f8
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#administrativeUnits/$entity",
"id": "49eb93f2-a5a2-4567-ad66-76a3ebd01d84",
"deletedDateTime": null,
"displayName": "Seattle District Technical Schools",
"description": "Seattle district technical schools administration",
"visibility": null,
"membershipRule": "(user.country -eq \"United States\")",
"membershipType": "Dynamic",
"membershipRuleProcessingState": "On"
}
Exemplo 2: Obter uma unidade administrativa de gestão restrita
Solicitação
GET https://graph.microsoft.com/beta/administrativeUnits/2sd35b05-ae71-48ab-9e7d-4r41a28te37d
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#administrativeUnits/$entity",
"id": "2sd35b05-ae71-48ab-9e7d-4r41a28te37d",
"deletedDateTime": null,
"displayName": "Executive Division",
"description": "Executive division administration",
"isMemberManagementRestricted": true
}