scoped_members

Creates, updates, deletes, gets or lists a scoped_members resource.

Overview

Name	scoped_members
Type	Resource
Id	entra_id.directory_roles.scoped_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	directory_role_id, scoped_role_membership_id		Members of this directory role that are scoped to administrative units. Read-only. Nullable.
list	select	directory_role_id		Retrieve a list of scopedRoleMembership objects for a directory role.
insert	insert	directory_role_id
update	update	directory_role_id, scoped_role_membership_id
delete	delete	directory_role_id, scoped_role_membership_id	If-Match

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
directory_role_id	string	The unique identifier of directoryRole
scoped_role_membership_id	string	The unique identifier of scopedRoleMembership
If-Match	string	ETag

SELECT examples

get

Members of this directory role that are scoped to administrative units. Read-only. Nullable.

SELECT
id,
administrativeUnitId,
roleId,
roleMemberInfo
FROM entra_id.directory_roles.scoped_members
WHERE directory_role_id = '{{ directory_role_id }}' -- required
AND scoped_role_membership_id = '{{ scoped_role_membership_id }}' -- required
;

list

Retrieve a list of scopedRoleMembership objects for a directory role.

SELECT
id,
administrativeUnitId,
roleId,
roleMemberInfo
FROM entra_id.directory_roles.scoped_members
WHERE directory_role_id = '{{ directory_role_id }}' -- required
;

INSERT examples

insert

No description available.

INSERT INTO entra_id.directory_roles.scoped_members (
id,
administrativeUnitId,
roleId,
roleMemberInfo,
directory_role_id
)
SELECT 
'{{ id }}',
'{{ administrativeUnitId }}',
'{{ roleId }}',
'{{ roleMemberInfo }}',
'{{ directory_role_id }}'
RETURNING
id,
administrativeUnitId,
roleId,
roleMemberInfo
;

Manifest

# Description fields are for documentation purposes
- name: scoped_members
props:
  - name: directory_role_id
    value: "{{ directory_role_id }}"
    description: Required parameter for the scoped_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_roles.scoped_members
SET 
id = '{{ id }}',
administrativeUnitId = '{{ administrativeUnitId }}',
roleId = '{{ roleId }}',
roleMemberInfo = '{{ roleMemberInfo }}'
WHERE 
directory_role_id = '{{ directory_role_id }}' --required
AND scoped_role_membership_id = '{{ scoped_role_membership_id }}' --required
RETURNING
id,
administrativeUnitId,
roleId,
roleMemberInfo;

DELETE examples

delete

No description available.

DELETE FROM entra_id.directory_roles.scoped_members
WHERE directory_role_id = '{{ directory_role_id }}' --required
AND scoped_role_membership_id = '{{ scoped_role_membership_id }}' --required
AND If-Match = '{{ If-Match }}'
;