編輯

共用方式為

Create administrativeUnit

  • 發行項

Namespace: microsoft.graph

Create a new administrativeUnit.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet
✅ ✅ ✅ ✅

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) AdministrativeUnit.ReadWrite.All Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application AdministrativeUnit.ReadWrite.All Not available.

Important

In delegated scenarios with work or school accounts, the signed-in user must be a member user or be assigned a supported Microsoft Entra role or a custom role with a supported role permission. Privileged Role Administrator is the least privileged role supported for this operation.

HTTP request

POST /directory/administrativeUnits

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-type application/json. Required.

Request body

In the request body, supply a JSON representation of an administrativeUnit object.

You can specify the following properties when you create an administrativeUnit.

Property Type Description
description String Description for the administrative unit. Optional.
displayName String Display name for the administrative unit. Required.
membershipRule String The dynamic membership rule for the administrative unit. For more information about the rules you can use for dynamic administrative units and dynamic groups, see Manage rules for dynamic membership groups in Microsoft Entra ID. Optional.
membershipRuleProcessingState String Controls whether the dynamic membership rule is actively processed. Set to On to activate the dynamic membership rule, or Paused to stop updating membership dynamically. Optional.
membershipType String Indicates the membership type for the administrative unit. The possible values are: dynamic, assigned. If not set, the default value is null and the default behavior is assigned. Optional.
visibility String The visibility of the administrative unit. If not set, the default value is null and the default behavior is public. It can be set to HiddenMembership to hide the membership from nonmembers. Optional.

The administrativeUnit resource supports extensions, which allows you to use the POST operation to add custom properties with your own data when you create the administrative unit.

Response

If successful, this method returns a 201 Created response code and an administrativeUnit object in the response body.

Example

Request

The following example shows a request that creates a new administrative unit with a dynamic membership rule to include all users whose country is the United States.

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"
}

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

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"
}

Related content