Criar administrativeUnit

Namespace: microsoft.graph

Crie uma nova administrativeUnit.

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

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos 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 com privilégios mais elevados
Delegado (conta corporativa ou de estudante) AdministrativeUnit.ReadWrite.All Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application AdministrativeUnit.ReadWrite.All Indisponível.

Importante

Para acesso delegado usando contas corporativas ou de estudante, o usuário conectado deve ser um usuário membro ou receber uma função do Microsoft Entra com suporte ou uma função personalizada que conceda as permissões necessárias para esta operação. O Administrador de Função Privilegiada é a função com menos privilégios com suporte para esta operação.

Solicitação HTTP

POST /directory/administrativeUnits

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. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça uma representação JSON de um objeto administrativeUnit .

É possível especificar as propriedades a seguir ao criar um administrativeUnit.

Propriedade Tipo Descrição
description Cadeia de caracteres Descrição da unidade administrativa. Opcional.
displayName Cadeia de caracteres Nome de exibição para a unidade administrativa. Obrigatório.
isMemberManagementRestricted Booliano true Se os membros dessa unidade administrativa devem ser tratados como confidenciais, o que requer permissões específicas para gerenciar. Caso contrário, o valor padrão será null e o comportamento padrão será false. Use esta propriedade para definir unidades administrativas com funções que não herdam de administradores no nível do locatário e onde o gerenciamento de objetos de membro individuais é limitado a administradores com escopo em uma unidade administrativa de gerenciamento restrita. Essa propriedade é imutável e não pode ser alterada posteriormente. Opcional.
membershipRule String A regra de associação dinâmica para a unidade administrativa. Para obter mais informações sobre as regras que você pode usar para unidades administrativas dinâmicas e grupos dinâmicos, consulte Gerenciar regras para grupos de associação dinâmica no Microsoft Entra ID. Opcional.
membershipRuleProcessingState String Controla se a regra de associação dinâmica é processada ativamente. Defina como On para ativar a regra de associação dinâmica ou Paused interromper a atualização da associação dinamicamente. Opcional.
membershipType Cadeia de caracteres Indica o tipo de associação da unidade administrativa. Os valores possíveis são: dynamic, assigned. Caso contrário, o valor padrão será null e o comportamento padrão será atribuído. Opcional.
visibility Cadeia de caracteres A visibilidade da unidade administrativa. Caso contrário, o valor padrão será null e o comportamento padrão será público. Ele pode ser definido para HiddenMembership ocultar a associação de não membros. Opcional.

O recurso administrativeUnit suporta extensões, o que permite usar a POST operação para adicionar propriedades customizadas com seus próprios dados ao criar a unidade administrativa.

Resposta

Se for bem-sucedido, esse método retornará um código de 201 Created resposta e um objeto administrativeUnit no corpo da resposta.

Exemplos

Exemplo 1: Criar uma unidade administrativa

O exemplo a seguir mostra como criar uma unidade administrativa.

Solicitação

O exemplo a seguir mostra uma solicitação que cria uma nova unidade administrativa com uma regra de associação dinâmica para incluir todos os usuários cujo país é os Estados Unidos.

POST https://graph.microsoft.com/v1.0/directory/administrativeUnits
Content-type: application/json

{
    "displayName": "Seattle District Technical Schools",
    "description": "Seattle district technical schools administration",
    "membershipType": "Dynamic",
    "membershipRule": "(user.country -eq \"United States\")",
    "membershipRuleProcessingState": "On",
    "visibility": "HiddenMembership"
}

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 201 Created
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#administrativeUnits/$entity",
    "id": "7a3dc8f3-b3a0-4164-9a99-ed36f3af039f",
    "deletedDateTime": null,
    "displayName": "Seattle District Technical Schools",
    "description": "Seattle district technical schools administration",
    "membershipRule": "(user.country -eq \"United States\")",
    "membershipType": "Dynamic",
    "membershipRuleProcessingState": "On",
    "visibility": "HiddenMembership"
}

Exemplo 2: Criar uma unidade administrativa de gerenciamento restrito

O exemplo a seguir mostra como criar uma nova unidade administrativa de gerenciamento restrito. A propriedade isMemberManagementRestricted é imutável e não pode ser alterada posteriormente.

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/v1.0/directory/administrativeUnits
Content-type: application/json

{
    "displayName": "Executive Division",
    "description": "Executive division administration",
    "isMemberManagementRestricted": true
}

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 201 Created
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#administrativeUnits/$entity",
    "id": "2sd35b05-ae71-48ab-9e7d-4r41a28te37d",
    "deletedDateTime": null,
    "displayName": "Executive Division",
    "description": "Executive division administration",
    "isMemberManagementRestricted": true,
    "visibility": null
}