entitlement_management_catalogs_resource_roles

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

Overview

Name	entitlement_management_catalogs_resource_roles
Type	Resource
Id	entra_id.identity_governance.entitlement_management_catalogs_resource_roles

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.
description	string	A description for the resource role.
displayName	string	The display name of the resource role such as the role defined by the application.
originId	string	The unique identifier of the resource role in the origin system. For a SharePoint Online site, the originId is the sequence number of the role in the site.
originSystem	string	The type of the resource in the origin system, such as SharePointOnline, AadApplication, or AadGroup.
resource

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
description	string	A description for the resource role.
displayName	string	The display name of the resource role such as the role defined by the application.
originId	string	The unique identifier of the resource role in the origin system. For a SharePoint Online site, the originId is the sequence number of the role in the site.
originSystem	string	The type of the resource in the origin system, such as SharePointOnline, AadApplication, or AadGroup.
resource

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	access_package_catalog_id, access_package_resource_role_id
list	select	access_package_catalog_id		Retrieve a list of accessPackageResourceRole objects of an accessPackageResource in an accessPackageCatalog. The resource should have been added to the catalog by creating an accessPackageResourceRequest. This list of roles can then be used by the caller to select a role, which is needed when subsequently creating an accessPackageResourceRoleScope.
insert	insert	access_package_catalog_id
update	update	access_package_catalog_id, access_package_resource_role_id
delete	delete	access_package_catalog_id, access_package_resource_role_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
access_package_catalog_id	string	The unique identifier of accessPackageCatalog
access_package_resource_role_id	string	The unique identifier of accessPackageResourceRole
If-Match	string	ETag

SELECT examples

get

Retrieved navigation property

SELECT
id,
description,
displayName,
originId,
originSystem,
resource
FROM entra_id.identity_governance.entitlement_management_catalogs_resource_roles
WHERE access_package_catalog_id = '{{ access_package_catalog_id }}' -- required
AND access_package_resource_role_id = '{{ access_package_resource_role_id }}' -- required
;

list

Retrieve a list of accessPackageResourceRole objects of an accessPackageResource in an accessPackageCatalog. The resource should have been added to the catalog by creating an accessPackageResourceRequest. This list of roles can then be used by the caller to select a role, which is needed when subsequently creating an accessPackageResourceRoleScope.

SELECT
id,
description,
displayName,
originId,
originSystem,
resource
FROM entra_id.identity_governance.entitlement_management_catalogs_resource_roles
WHERE access_package_catalog_id = '{{ access_package_catalog_id }}' -- required
;

INSERT examples

insert

No description available.

INSERT INTO entra_id.identity_governance.entitlement_management_catalogs_resource_roles (
id,
description,
displayName,
originId,
originSystem,
resource,
access_package_catalog_id
)
SELECT 
'{{ id }}',
'{{ description }}',
'{{ displayName }}',
'{{ originId }}',
'{{ originSystem }}',
'{{ resource }}',
'{{ access_package_catalog_id }}'
RETURNING
id,
description,
displayName,
originId,
originSystem,
resource
;

Manifest

# Description fields are for documentation purposes
- name: entitlement_management_catalogs_resource_roles
props:
  - name: access_package_catalog_id
    value: "{{ access_package_catalog_id }}"
    description: Required parameter for the entitlement_management_catalogs_resource_roles resource.
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: description
    value: "{{ description }}"
    description: |
      A description for the resource role.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The display name of the resource role such as the role defined by the application.
  - name: originId
    value: "{{ originId }}"
    description: |
      The unique identifier of the resource role in the origin system. For a SharePoint Online site, the originId is the sequence number of the role in the site.
  - name: originSystem
    value: "{{ originSystem }}"
    description: |
      The type of the resource in the origin system, such as SharePointOnline, AadApplication, or AadGroup.
  - name: resource
    value: "{{ resource }}"

UPDATE examples

update

No description available.

UPDATE entra_id.identity_governance.entitlement_management_catalogs_resource_roles
SET 
id = '{{ id }}',
description = '{{ description }}',
displayName = '{{ displayName }}',
originId = '{{ originId }}',
originSystem = '{{ originSystem }}',
resource = '{{ resource }}'
WHERE 
access_package_catalog_id = '{{ access_package_catalog_id }}' --required
AND access_package_resource_role_id = '{{ access_package_resource_role_id }}' --required
RETURNING
id,
description,
displayName,
originId,
originSystem,
resource;

DELETE examples

delete

No description available.

DELETE FROM entra_id.identity_governance.entitlement_management_catalogs_resource_roles
WHERE access_package_catalog_id = '{{ access_package_catalog_id }}' --required
AND access_package_resource_role_id = '{{ access_package_resource_role_id }}' --required
AND If-Match = '{{ If-Match }}'
;