entitlement_management_catalogs_resource_scopes_resource_scopes

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

Overview

Name	entitlement_management_catalogs_resource_scopes_resource_scopes
Type	Resource
Id	entra_id.identity_governance.entitlement_management_catalogs_resource_scopes_resource_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.
description	string	The description of the scope.
displayName	string	The display name of the scope.
isRootScope	boolean	True if the scopes are arranged in a hierarchy and this is the top or root scope of the resource.
originId	string	The unique identifier for the scope in the resource as defined in the origin system.
originSystem	string	The origin system for the scope.
resource

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
description	string	The description of the scope.
displayName	string	The display name of the scope.
isRootScope	boolean	True if the scopes are arranged in a hierarchy and this is the top or root scope of the resource.
originId	string	The unique identifier for the scope in the resource as defined in the origin system.
originSystem	string	The origin system for the scope.
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_scope_id, access_package_resource_scope_id1		Read-only. Nullable. Supports $expand.
list	select	access_package_catalog_id, access_package_resource_scope_id		Read-only. Nullable. Supports $expand.
insert	insert	access_package_catalog_id, access_package_resource_scope_id
update	update	access_package_catalog_id, access_package_resource_scope_id, access_package_resource_scope_id1
delete	delete	access_package_catalog_id, access_package_resource_scope_id, access_package_resource_scope_id1	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_scope_id	string	The unique identifier of accessPackageResourceScope
access_package_resource_scope_id1	string	The unique identifier of accessPackageResourceScope
If-Match	string	ETag

SELECT examples

get

Read-only. Nullable. Supports $expand.

SELECT
id,
description,
displayName,
isRootScope,
originId,
originSystem,
resource
FROM entra_id.identity_governance.entitlement_management_catalogs_resource_scopes_resource_scopes
WHERE access_package_catalog_id = '{{ access_package_catalog_id }}' -- required
AND access_package_resource_scope_id = '{{ access_package_resource_scope_id }}' -- required
AND access_package_resource_scope_id1 = '{{ access_package_resource_scope_id1 }}' -- required
;

list

Read-only. Nullable. Supports $expand.

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

INSERT examples

insert

No description available.

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

Manifest

# Description fields are for documentation purposes
- name: entitlement_management_catalogs_resource_scopes_resource_scopes
props:
  - name: access_package_catalog_id
    value: "{{ access_package_catalog_id }}"
    description: Required parameter for the entitlement_management_catalogs_resource_scopes_resource_scopes resource.
  - name: access_package_resource_scope_id
    value: "{{ access_package_resource_scope_id }}"
    description: Required parameter for the entitlement_management_catalogs_resource_scopes_resource_scopes resource.
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: description
    value: "{{ description }}"
    description: |
      The description of the scope.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The display name of the scope.
  - name: isRootScope
    value: {{ isRootScope }}
    description: |
      True if the scopes are arranged in a hierarchy and this is the top or root scope of the resource.
  - name: originId
    value: "{{ originId }}"
    description: |
      The unique identifier for the scope in the resource as defined in the origin system.
  - name: originSystem
    value: "{{ originSystem }}"
    description: |
      The origin system for the scope.
  - name: resource
    value: "{{ resource }}"

UPDATE examples

update

No description available.

UPDATE entra_id.identity_governance.entitlement_management_catalogs_resource_scopes_resource_scopes
SET 
id = '{{ id }}',
description = '{{ description }}',
displayName = '{{ displayName }}',
isRootScope = {{ isRootScope }},
originId = '{{ originId }}',
originSystem = '{{ originSystem }}',
resource = '{{ resource }}'
WHERE 
access_package_catalog_id = '{{ access_package_catalog_id }}' --required
AND access_package_resource_scope_id = '{{ access_package_resource_scope_id }}' --required
AND access_package_resource_scope_id1 = '{{ access_package_resource_scope_id1 }}' --required
RETURNING
id,
description,
displayName,
isRootScope,
originId,
originSystem,
resource;

DELETE examples

delete

No description available.

DELETE FROM entra_id.identity_governance.entitlement_management_catalogs_resource_scopes_resource_scopes
WHERE access_package_catalog_id = '{{ access_package_catalog_id }}' --required
AND access_package_resource_scope_id = '{{ access_package_resource_scope_id }}' --required
AND access_package_resource_scope_id1 = '{{ access_package_resource_scope_id1 }}' --required
AND If-Match = '{{ If-Match }}'
;