Skip to main content

entitlement_management_access_packages_resource_role_scopes_scope_resource

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

Overview

Nameentitlement_management_access_packages_resource_role_scopes_scope_resource
TypeResource
Identra_id.identity_governance.entitlement_management_access_packages_resource_role_scopes_scope_resource

Fields

The following fields are returned by SELECT queries:

Retrieved navigation property

NameDatatypeDescription
idstringThe unique identifier for an entity. Read-only.
attributesarrayContains information about the attributes to be collected from the requestor and sent to the resource application.
createdDateTimestring (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. Read-only. (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])$)
descriptionstringA description for the resource.
displayNamestringThe display name of the resource, such as the application name, group name or site name.
environmentContains the environment information for the resource. This can be set using either the @odata.bind annotation or the environment's originId.Supports $expand.
modifiedDateTimestring (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. Read-only. (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])$)
originIdstringThe unique identifier of the resource in the origin system. For a Microsoft Entra group, this is the identifier of the group.
originSystemstringThe type of the resource in the origin system, such as SharePointOnline, AadApplication or AadGroup.
rolesarrayRead-only. Nullable. Supports $expand.
scopesarrayRead-only. Nullable. Supports $expand.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectaccess_package_id, access_package_resource_role_scope_id
updateupdateaccess_package_id, access_package_resource_role_scope_id
deletedeleteaccess_package_id, access_package_resource_role_scope_idIf-Match
refreshexecaccess_package_id, access_package_resource_role_scope_id

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.

NameDatatypeDescription
access_package_idstringThe unique identifier of accessPackage
access_package_resource_role_scope_idstringThe unique identifier of accessPackageResourceRoleScope
If-MatchstringETag

SELECT examples

Retrieved navigation property

SELECT
id,
attributes,
createdDateTime,
description,
displayName,
environment,
modifiedDateTime,
originId,
originSystem,
roles,
scopes
FROM entra_id.identity_governance.entitlement_management_access_packages_resource_role_scopes_scope_resource
WHERE access_package_id = '{{ access_package_id }}' -- required
AND access_package_resource_role_scope_id = '{{ access_package_resource_role_scope_id }}' -- required
;

UPDATE examples

No description available.

UPDATE entra_id.identity_governance.entitlement_management_access_packages_resource_role_scopes_scope_resource
SET
id = '{{ id }}',
attributes = '{{ attributes }}',
createdDateTime = '{{ createdDateTime }}',
description = '{{ description }}',
displayName = '{{ displayName }}',
modifiedDateTime = '{{ modifiedDateTime }}',
originId = '{{ originId }}',
originSystem = '{{ originSystem }}',
environment = '{{ environment }}',
roles = '{{ roles }}',
scopes = '{{ scopes }}'
WHERE
access_package_id = '{{ access_package_id }}' --required
AND access_package_resource_role_scope_id = '{{ access_package_resource_role_scope_id }}' --required
RETURNING
id,
attributes,
createdDateTime,
description,
displayName,
environment,
modifiedDateTime,
originId,
originSystem,
roles,
scopes;

DELETE examples

No description available.

DELETE FROM entra_id.identity_governance.entitlement_management_access_packages_resource_role_scopes_scope_resource
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 }}'
;

Lifecycle Methods

Success

EXEC entra_id.identity_governance.entitlement_management_access_packages_resource_role_scopes_scope_resource.refresh
@access_package_id='{{ access_package_id }}' --required,
@access_package_resource_role_scope_id='{{ access_package_resource_role_scope_id }}' --required
;