entitlement_management_catalogs_access_packages

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

Overview

Name	entitlement_management_catalogs_access_packages
Type	Resource
Id	entra_id.identity_governance.entitlement_management_catalogs_access_packages

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.
accessPackagesIncompatibleWith	array	The access packages that are incompatible with this package. Read-only.
assignmentPolicies	array	Read-only. Nullable. Supports $expand.
catalog		Required when creating the access package. Read-only. Nullable.
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])$)
description	string	The description of the access package.
displayName	string	Required. The display name of the access package. Supports $filter (eq, contains).
incompatibleAccessPackages	array	The access packages whose assigned users are ineligible to be assigned this access package.
incompatibleGroups	array	The groups whose members are ineligible to be assigned this access package.
isHidden	boolean	Indicates whether the access package is hidden from the requestor.
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])$)
resourceRoleScopes	array	The resource roles and scopes in this access package.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
accessPackagesIncompatibleWith	array	The access packages that are incompatible with this package. Read-only.
assignmentPolicies	array	Read-only. Nullable. Supports $expand.
catalog		Required when creating the access package. Read-only. Nullable.
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])$)
description	string	The description of the access package.
displayName	string	Required. The display name of the access package. Supports $filter (eq, contains).
incompatibleAccessPackages	array	The access packages whose assigned users are ineligible to be assigned this access package.
incompatibleGroups	array	The groups whose members are ineligible to be assigned this access package.
isHidden	boolean	Indicates whether the access package is hidden from the requestor.
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])$)
resourceRoleScopes	array	The resource roles and scopes in this access package.

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_id		The access packages in this catalog. Read-only. Nullable.
list	select	access_package_catalog_id		The access packages in this catalog. Read-only. Nullable.

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_id	string	The unique identifier of accessPackage

SELECT examples

get

The access packages in this catalog. Read-only. Nullable.

SELECT
id,
accessPackagesIncompatibleWith,
assignmentPolicies,
catalog,
createdDateTime,
description,
displayName,
incompatibleAccessPackages,
incompatibleGroups,
isHidden,
modifiedDateTime,
resourceRoleScopes
FROM entra_id.identity_governance.entitlement_management_catalogs_access_packages
WHERE access_package_catalog_id = '{{ access_package_catalog_id }}' -- required
AND access_package_id = '{{ access_package_id }}' -- required
;

list

The access packages in this catalog. Read-only. Nullable.

SELECT
id,
accessPackagesIncompatibleWith,
assignmentPolicies,
catalog,
createdDateTime,
description,
displayName,
incompatibleAccessPackages,
incompatibleGroups,
isHidden,
modifiedDateTime,
resourceRoleScopes
FROM entra_id.identity_governance.entitlement_management_catalogs_access_packages
WHERE access_package_catalog_id = '{{ access_package_catalog_id }}' -- required
;