administrative_units_scoped_role_members

Creates, updates, deletes, gets or lists an administrative_units_scoped_role_members resource.

Overview

Name	administrative_units_scoped_role_members
Type	Resource
Id	entra_id.directory.administrative_units_scoped_role_members

Fields

The following fields are returned by SELECT queries:

get

Retrieved navigation property

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
administrativeUnitId	string	Unique identifier for the administrative unit that the directory role is scoped to
roleId	string	Unique identifier for the directory role that the member is in.
roleMemberInfo	object	(title: identity)

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
administrativeUnitId	string	Unique identifier for the administrative unit that the directory role is scoped to
roleId	string	Unique identifier for the directory role that the member is in.
roleMemberInfo	object	(title: identity)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	administrative_unit_id, scoped_role_membership_id		Get a Microsoft Entra role assignment with administrative unit scope.
list	select	administrative_unit_id		List Microsoft Entra role assignments with administrative unit scope.
insert	insert	administrative_unit_id		Assign a Microsoft Entra role with administrative unit scope. For a list of roles that can be assigned with administrative unit scope, see Assign Microsoft Entra roles with administrative unit scope.
update	update	administrative_unit_id, scoped_role_membership_id
delete	delete	administrative_unit_id, scoped_role_membership_id	If-Match	Remove a Microsoft Entra role assignment with administrative unit scope.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
administrative_unit_id	string	The unique identifier of administrativeUnit
scoped_role_membership_id	string	The unique identifier of scopedRoleMembership
If-Match	string	ETag

SELECT examples

get

Get a Microsoft Entra role assignment with administrative unit scope.

SELECT
id,
administrativeUnitId,
roleId,
roleMemberInfo
FROM entra_id.directory.administrative_units_scoped_role_members
WHERE administrative_unit_id = '{{ administrative_unit_id }}' -- required
AND scoped_role_membership_id = '{{ scoped_role_membership_id }}' -- required
;

list

List Microsoft Entra role assignments with administrative unit scope.

SELECT
id,
administrativeUnitId,
roleId,
roleMemberInfo
FROM entra_id.directory.administrative_units_scoped_role_members
WHERE administrative_unit_id = '{{ administrative_unit_id }}' -- required
;

INSERT examples

insert

Assign a Microsoft Entra role with administrative unit scope. For a list of roles that can be assigned with administrative unit scope, see Assign Microsoft Entra roles with administrative unit scope.

INSERT INTO entra_id.directory.administrative_units_scoped_role_members (
id,
administrativeUnitId,
roleId,
roleMemberInfo,
administrative_unit_id
)
SELECT 
'{{ id }}',
'{{ administrativeUnitId }}',
'{{ roleId }}',
'{{ roleMemberInfo }}',
'{{ administrative_unit_id }}'
RETURNING
id,
administrativeUnitId,
roleId,
roleMemberInfo
;

Manifest

# Description fields are for documentation purposes
- name: administrative_units_scoped_role_members
props:
  - name: administrative_unit_id
    value: "{{ administrative_unit_id }}"
    description: Required parameter for the administrative_units_scoped_role_members resource.
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: administrativeUnitId
    value: "{{ administrativeUnitId }}"
    description: |
      Unique identifier for the administrative unit that the directory role is scoped to
  - name: roleId
    value: "{{ roleId }}"
    description: |
      Unique identifier for the directory role that the member is in.
  - name: roleMemberInfo
    value:
      displayName: "{{ displayName }}"
      id: "{{ id }}"

UPDATE examples

update

No description available.

UPDATE entra_id.directory.administrative_units_scoped_role_members
SET 
id = '{{ id }}',
administrativeUnitId = '{{ administrativeUnitId }}',
roleId = '{{ roleId }}',
roleMemberInfo = '{{ roleMemberInfo }}'
WHERE 
administrative_unit_id = '{{ administrative_unit_id }}' --required
AND scoped_role_membership_id = '{{ scoped_role_membership_id }}' --required
RETURNING
id,
administrativeUnitId,
roleId,
roleMemberInfo;

DELETE examples

delete

Remove a Microsoft Entra role assignment with administrative unit scope.

DELETE FROM entra_id.directory.administrative_units_scoped_role_members
WHERE administrative_unit_id = '{{ administrative_unit_id }}' --required
AND scoped_role_membership_id = '{{ scoped_role_membership_id }}' --required
AND If-Match = '{{ If-Match }}'
;