Skip to content

Latest commit

 

History

History
119 lines (93 loc) · 8.15 KB

administrativeunit.md

File metadata and controls

119 lines (93 loc) · 8.15 KB
Raw
title description ms.localizationpriority author ms.subservice doc_type
administrativeUnit resource type
An administrative unit provides a conceptual container for User and Group directory objects.
medium
DougKirschner
entra-directory-management
resourcePageType

administrativeUnit resource type

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

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:

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.
Get delta administrativeUnit Get newly created, updated, or deleted administrativeUnits without having to perform a full read of the entire resource collection.
Add member directoryObject Add a member (user or group).
List members directoryObject collection Get the list of (user and group) members.
Get member directoryObject Get a specific member.
Remove member directoryObject Remove a member.
Assign role with scope scopedRoleMembership Assign a Microsoft Entra role with administrative unit scope.
List role assignments with scope scopedRoleMembership collection List Microsoft Entra role assignments with administrative unit scope.
Get role assignment with scope scopedRoleMembership Get a Microsoft Entra role assignment with administrative unit scope.
Remove role assignment with scope scopedRoleMembership Remove a Microsoft Entra role assignment with administrative unit scope.

Note

The URL endpoint for calling the administrativeUnits API is /administrativeUnits in the beta endpoint but /directory/administrativeUnits in the v1.0 endpoint.

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).
isMemberManagementRestricted Boolean true if members of this administrative unit should be treated as sensitive, which requires specific permissions to manage. Default value is false. Use this property to define administrative units whose roles don't inherit from tenant-level administrators, and management of individual member objects is limited to administrators scoped to a restricted management administrative unit. Immutable, so can't be changed later.

For more information about working with restricted management administrative units, see Restricted management administrative units in Microsoft Entra ID.
membershipRule String Dynamic membership rule for the administrative unit. For more about the rules that you can use for dynamic administrative units and dynamic groups, see Using attributes to create advanced rules.
membershipRuleProcessingState String Used to control whether the dynamic membership rule is actively processed. Set to On when you want the dynamic membership rule to be active and Paused if you want to stop updating membership dynamically. If not set, the default behavior is Paused.
membershipType String Membership type for the administrative unit. Can be dynamic or assigned. If not set, the default behavior is assigned.
visibility String Controls whether the administrative unit and its members are hidden or public. Can be set to HiddenMembership or Public. If not set, 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
extensions extension collection The collection of open extensions defined for this administrative unit. Nullable.
members directoryObject collection Users and groups that are members of this administrative unit. Supports $expand.
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",
  "membershipType": "String",
  "membershipRule": "String",
  "membershipRuleProcessingState": "String"
}

Related content