administrativeUnit resource type

Namespace: microsoft.graph

An administrative unit provides a conceptual container for user, group, and device directory objects. With administrative units, a company administrator can now delegate administrative responsibilities to manage the users, groups, and devices contained within or scoped to an administrative unit to a regional or departmental administrator. For more information about administrative units, see Administrative units in Microsoft Entra ID.

This resource is an open type that allows other properties to be passed in.

This resource supports:

  • Adding your own data to custom properties as extensions.
  • Using delta query to track incremental additions, deletions, and updates, by providing a delta function.

Methods

Method Return Type Description
Create administrativeUnit Create a new administrative unit.
List administrativeUnit collection List properties of all administrativeUnits.
Get administrativeUnit Read properties and relationships of a specific administrativeUnit object.
Update administrativeUnit Update administrativeUnit object.
Delete None Delete administrativeUnit object.
Add a member directoryObject Add a member (user, group, or device).
List members directoryObject collection Get the list of (user, group, or device) members.
Get a member directoryObject Get a specific member.
Remove a member directoryObject Remove a member.
Add a scopedRoleMember scopedRoleMembership Assign a Microsoft Entra role with administrative unit scope.
List scopedRoleMembers scopedRoleMembership collection List Microsoft Entra role assignments with administrative unit scope.
Get a scopedRoleMember scopedRoleMembership Get a Microsoft Entra role assignment with administrative unit scope.
Remove a scopedRoleMember scopedRoleMembership Remove a Microsoft Entra role assignment with administrative unit scope.

Properties

Important

Specific usage of $filter and the $search query parameter is supported only when you use the ConsistencyLevel header set to eventual and $count. For more information, see Advanced query capabilities on directory objects.

Property Type Description
description String An optional description for the administrative unit. Supports $filter (eq, ne, in, startsWith), $search.
displayName String Display name for the administrative unit. Supports $filter (eq, ne, not, ge, le, in, startsWith, and eq on null values), $search, and $orderby.
id String Unique identifier for the administrative unit. Read-only. Supports $filter (eq).
visibility String Controls whether the administrative unit and its members are hidden or public. Can be set to HiddenMembership. If not set (value is null), the default behavior is public. When set to HiddenMembership, only members of the administrative unit can list other members of the administrative unit.

Tip

Directory extensions and associated data are returned by default while schema extensions and associated data returned only on $select.

Relationships

Relationship Type Description
members directoryObject collection Users and groups that are members of this administrative unit. Supports $expand.
extensions extension collection The collection of open extensions defined for this administrative unit. Nullable.
scopedRoleMembers scopedRoleMembership collection Scoped-role members of this administrative unit.

JSON representation

The following JSON representation shows the resource type.

{
  "description": "String",
  "displayName": "String",
  "id": "String (identifier)",
  "visibility": "String"
}