entitlement_management_catalogs

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

Overview

Name	entitlement_management_catalogs
Type	Resource
Id	entra_id.identity_governance.entitlement_management_catalogs

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.
accessPackages	array	The access packages in this catalog. Read-only. Nullable.
catalogType		Whether the catalog is created by a user or entitlement management. The possible values are: userManaged, serviceDefault, serviceManaged, unknownFutureValue.
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. 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])$)
customWorkflowExtensions	array
description	string	The description of the access package catalog.
displayName	string	The display name of the access package catalog.
isExternallyVisible	boolean	Whether the access packages in this catalog can be requested by users outside of the tenant.
modifiedDateTime	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. 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])$)
resourceRoles	array
resourceScopes	array
resources	array	Access package resources in this catalog.
state		Has the value published if the access packages are available for management. The possible values are: unpublished, published, unknownFutureValue.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
accessPackages	array	The access packages in this catalog. Read-only. Nullable.
catalogType		Whether the catalog is created by a user or entitlement management. The possible values are: userManaged, serviceDefault, serviceManaged, unknownFutureValue.
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. 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])$)
customWorkflowExtensions	array
description	string	The description of the access package catalog.
displayName	string	The display name of the access package catalog.
isExternallyVisible	boolean	Whether the access packages in this catalog can be requested by users outside of the tenant.
modifiedDateTime	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. 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])$)
resourceRoles	array
resourceScopes	array
resources	array	Access package resources in this catalog.
state		Has the value published if the access packages are available for management. The possible values are: unpublished, published, unknownFutureValue.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	access_package_catalog_id		Retrieve the properties and relationships of an accessPackageCatalog object.
list	select			Retrieve a list of accessPackageCatalog objects.
insert	insert			Create a new accessPackageCatalog object.
update	update	access_package_catalog_id		Update an existing accessPackageCatalog object to change one or more of its properties, such as the display name or description.
delete	delete	access_package_catalog_id	If-Match	Delete an accessPackageCatalog.

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
If-Match	string	ETag

SELECT examples

get

Retrieve the properties and relationships of an accessPackageCatalog object.

SELECT
id,
accessPackages,
catalogType,
createdDateTime,
customWorkflowExtensions,
description,
displayName,
isExternallyVisible,
modifiedDateTime,
resourceRoles,
resourceScopes,
resources,
state
FROM entra_id.identity_governance.entitlement_management_catalogs
WHERE access_package_catalog_id = '{{ access_package_catalog_id }}' -- required
;

list

Retrieve a list of accessPackageCatalog objects.

SELECT
id,
accessPackages,
catalogType,
createdDateTime,
customWorkflowExtensions,
description,
displayName,
isExternallyVisible,
modifiedDateTime,
resourceRoles,
resourceScopes,
resources,
state
FROM entra_id.identity_governance.entitlement_management_catalogs
;

INSERT examples

insert

Create a new accessPackageCatalog object.

INSERT INTO entra_id.identity_governance.entitlement_management_catalogs (
id,
catalogType,
createdDateTime,
description,
displayName,
isExternallyVisible,
modifiedDateTime,
state,
accessPackages,
customWorkflowExtensions,
resourceRoles,
resources,
resourceScopes
)
SELECT 
'{{ id }}',
'{{ catalogType }}',
'{{ createdDateTime }}',
'{{ description }}',
'{{ displayName }}',
{{ isExternallyVisible }},
'{{ modifiedDateTime }}',
'{{ state }}',
'{{ accessPackages }}',
'{{ customWorkflowExtensions }}',
'{{ resourceRoles }}',
'{{ resources }}',
'{{ resourceScopes }}'
RETURNING
id,
accessPackages,
catalogType,
createdDateTime,
customWorkflowExtensions,
description,
displayName,
isExternallyVisible,
modifiedDateTime,
resourceRoles,
resourceScopes,
resources,
state
;

Manifest

# Description fields are for documentation purposes
- name: entitlement_management_catalogs
props:
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: catalogType
    value: "{{ catalogType }}"
    description: |
      Whether the catalog is created by a user or entitlement management. The possible values are: userManaged, serviceDefault, serviceManaged, unknownFutureValue.
  - 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. Read-only.
  - name: description
    value: "{{ description }}"
    description: |
      The description of the access package catalog.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The display name of the access package catalog.
  - name: isExternallyVisible
    value: {{ isExternallyVisible }}
    description: |
      Whether the access packages in this catalog can be requested by users outside of the tenant.
  - name: modifiedDateTime
    value: "{{ modifiedDateTime }}"
    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. Read-only.
  - name: state
    value: "{{ state }}"
    description: |
      Has the value published if the access packages are available for management. The possible values are: unpublished, published, unknownFutureValue.
  - name: accessPackages
    description: |
      The access packages in this catalog. Read-only. Nullable.
    value:
      - id: "{{ id }}"
        createdDateTime: "{{ createdDateTime }}"
        description: "{{ description }}"
        displayName: "{{ displayName }}"
        isHidden: {{ isHidden }}
        modifiedDateTime: "{{ modifiedDateTime }}"
        accessPackagesIncompatibleWith: "{{ accessPackagesIncompatibleWith }}"
        assignmentPolicies: "{{ assignmentPolicies }}"
        catalog: "{{ catalog }}"
        incompatibleAccessPackages: "{{ incompatibleAccessPackages }}"
        incompatibleGroups: "{{ incompatibleGroups }}"
        resourceRoleScopes: "{{ resourceRoleScopes }}"
  - name: customWorkflowExtensions
    value:
      - id: "{{ id }}"
        authenticationConfiguration: "{{ authenticationConfiguration }}"
        clientConfiguration: "{{ clientConfiguration }}"
        description: "{{ description }}"
        displayName: "{{ displayName }}"
        endpointConfiguration: "{{ endpointConfiguration }}"
  - name: resourceRoles
    value:
      - id: "{{ id }}"
        description: "{{ description }}"
        displayName: "{{ displayName }}"
        originId: "{{ originId }}"
        originSystem: "{{ originSystem }}"
        resource: "{{ resource }}"
  - name: resources
    description: |
      Access package resources in this catalog.
    value:
      - id: "{{ id }}"
        attributes: "{{ attributes }}"
        createdDateTime: "{{ createdDateTime }}"
        description: "{{ description }}"
        displayName: "{{ displayName }}"
        modifiedDateTime: "{{ modifiedDateTime }}"
        originId: "{{ originId }}"
        originSystem: "{{ originSystem }}"
        environment: "{{ environment }}"
        roles: "{{ roles }}"
        scopes: "{{ scopes }}"
  - name: resourceScopes
    value:
      - id: "{{ id }}"
        description: "{{ description }}"
        displayName: "{{ displayName }}"
        isRootScope: {{ isRootScope }}
        originId: "{{ originId }}"
        originSystem: "{{ originSystem }}"
        resource: "{{ resource }}"

UPDATE examples

update

Update an existing accessPackageCatalog object to change one or more of its properties, such as the display name or description.

UPDATE entra_id.identity_governance.entitlement_management_catalogs
SET 
id = '{{ id }}',
catalogType = '{{ catalogType }}',
createdDateTime = '{{ createdDateTime }}',
description = '{{ description }}',
displayName = '{{ displayName }}',
isExternallyVisible = {{ isExternallyVisible }},
modifiedDateTime = '{{ modifiedDateTime }}',
state = '{{ state }}',
accessPackages = '{{ accessPackages }}',
customWorkflowExtensions = '{{ customWorkflowExtensions }}',
resourceRoles = '{{ resourceRoles }}',
resources = '{{ resources }}',
resourceScopes = '{{ resourceScopes }}'
WHERE 
access_package_catalog_id = '{{ access_package_catalog_id }}' --required
RETURNING
id,
accessPackages,
catalogType,
createdDateTime,
customWorkflowExtensions,
description,
displayName,
isExternallyVisible,
modifiedDateTime,
resourceRoles,
resourceScopes,
resources,
state;

DELETE examples

delete

Delete an accessPackageCatalog.

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