entitlement_management_access_packages_resource_role_scopes

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

Overview

Name	entitlement_management_access_packages_resource_role_scopes
Type	Resource
Id	entra_id.identity_governance.entitlement_management_access_packages_resource_role_scopes

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.
createdDateTime	string (date-time)	The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
role
scope

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
createdDateTime	string (date-time)	The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
role
scope

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	access_package_id, access_package_resource_role_scope_id		The resource roles and scopes in this access package.
list	select	access_package_id		The resource roles and scopes in this access package.
insert	insert	access_package_id		Create a new accessPackageResourceRoleScope for adding a resource role to an access package. The access package resource, for a group, an app, or a SharePoint Online site, must already exist in the access package catalog, and the originId for the resource role retrieved from the list of the resource roles. Once you add the resource role scope to the access package, the user will receive this resource role through any current and future access package assignments.
update	update	access_package_id, access_package_resource_role_scope_id
delete	delete	access_package_id, access_package_resource_role_scope_id	If-Match	Remove an accessPackageResourceRoleScope from an accessPackage list of resource role scopes.

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
access_package_id	string	The unique identifier of accessPackage
access_package_resource_role_scope_id	string	The unique identifier of accessPackageResourceRoleScope
If-Match	string	ETag

SELECT examples

get

The resource roles and scopes in this access package.

SELECT
id,
createdDateTime,
role,
scope
FROM entra_id.identity_governance.entitlement_management_access_packages_resource_role_scopes
WHERE access_package_id = '{{ access_package_id }}' -- required
AND access_package_resource_role_scope_id = '{{ access_package_resource_role_scope_id }}' -- required
;

list

The resource roles and scopes in this access package.

SELECT
id,
createdDateTime,
role,
scope
FROM entra_id.identity_governance.entitlement_management_access_packages_resource_role_scopes
WHERE access_package_id = '{{ access_package_id }}' -- required
;

INSERT examples

insert

Create a new accessPackageResourceRoleScope for adding a resource role to an access package. The access package resource, for a group, an app, or a SharePoint Online site, must already exist in the access package catalog, and the originId for the resource role retrieved from the list of the resource roles. Once you add the resource role scope to the access package, the user will receive this resource role through any current and future access package assignments.

INSERT INTO entra_id.identity_governance.entitlement_management_access_packages_resource_role_scopes (
id,
createdDateTime,
role,
scope,
access_package_id
)
SELECT 
'{{ id }}',
'{{ createdDateTime }}',
'{{ role }}',
'{{ scope }}',
'{{ access_package_id }}'
RETURNING
id,
createdDateTime,
role,
scope
;

Manifest

# Description fields are for documentation purposes
- name: entitlement_management_access_packages_resource_role_scopes
props:
  - name: access_package_id
    value: "{{ access_package_id }}"
    description: Required parameter for the entitlement_management_access_packages_resource_role_scopes resource.
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: createdDateTime
    value: "{{ createdDateTime }}"
    description: |
      The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
  - name: role
    value: "{{ role }}"
  - name: scope
    value: "{{ scope }}"

UPDATE examples

update

No description available.

UPDATE entra_id.identity_governance.entitlement_management_access_packages_resource_role_scopes
SET 
id = '{{ id }}',
createdDateTime = '{{ createdDateTime }}',
role = '{{ role }}',
scope = '{{ scope }}'
WHERE 
access_package_id = '{{ access_package_id }}' --required
AND access_package_resource_role_scope_id = '{{ access_package_resource_role_scope_id }}' --required
RETURNING
id,
createdDateTime,
role,
scope;

DELETE examples

delete

Remove an accessPackageResourceRoleScope from an accessPackage list of resource role scopes.

DELETE FROM entra_id.identity_governance.entitlement_management_access_packages_resource_role_scopes
WHERE access_package_id = '{{ access_package_id }}' --required
AND access_package_resource_role_scope_id = '{{ access_package_resource_role_scope_id }}' --required
AND If-Match = '{{ If-Match }}'
;