Skip to main content

entitlement_management_assignments

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

Overview​

Nameentitlement_management_assignments
TypeResource
Identra_id.identity_governance.entitlement_management_assignments

Fields​

The following fields are returned by SELECT queries:

Retrieved navigation property

NameDatatypeDescription
idstringThe unique identifier for an entity. Read-only.
accessPackageRead-only. Nullable. Supports $filter (eq) on the id property and $expand query parameters.
assignmentPolicyRead-only. Supports $filter (eq) on the id property and $expand query parameters.
customExtensionCalloutInstancesarrayInformation about all the custom extension calls that were made during the access package assignment workflow.
expiredDateTimestring (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])$)
scheduleWhen the access assignment is to be in place. Read-only.
stateThe state of the access package assignment. The possible values are: delivering, partiallyDelivered, delivered, expired, deliveryFailed, unknownFutureValue. Read-only. Supports $filter (eq).
statusstringMore information about the assignment lifecycle. Possible values include Delivering, Delivered, AutoAssignmentInGracePeriod, NearExpiry1DayNotificationTriggered, or ExpiredNotificationTriggered. Read-only.
targetThe subject of the access package assignment. Read-only. Nullable. Supports $expand. Supports $filter (eq) on objectId.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectaccess_package_assignment_idIn Microsoft Entra entitlement management, retrieve the properties and relationships of an accessPackageAssignment object.
listselectIn Microsoft Entra entitlement management, retrieve a list of accessPackageAssignment objects. For directory-wide administrators, the resulting list includes all the assignments, current and well as expired, that the caller has access to read, across all catalogs and access packages. If the caller is on behalf of a delegated user who is assigned only to catalog-specific delegated administrative roles, the request must supply a filter to indicate a specific access package, such as: $filter=accessPackage/id eq 'a914b616-e04e-476b-aa37-91038f0b165b'.
insertinsert
updateupdateaccess_package_assignment_id
deletedeleteaccess_package_assignment_idIf-Match
reprocessexecaccess_package_assignment_idIn Microsoft Entra entitlement management, callers can automatically reevaluate and enforce an accessPackageAssignment object of a user’s assignments for a specific access package. The state of the access package assignment must be Delivered for the administrator to reprocess the user's assignment. Only admins with the Access Package Assignment Manager role, or higher, in Microsoft Entra entitlement management can perform this action.

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_assignment_idstringThe unique identifier of accessPackageAssignment
If-MatchstringETag

SELECT examples​

In Microsoft Entra entitlement management, retrieve the properties and relationships of an accessPackageAssignment object.

SELECT
id,
accessPackage,
assignmentPolicy,
customExtensionCalloutInstances,
expiredDateTime,
schedule,
state,
status,
target
FROM entra_id.identity_governance.entitlement_management_assignments
WHERE access_package_assignment_id = '{{ access_package_assignment_id }}' -- required
;

INSERT examples​

No description available.

INSERT INTO entra_id.identity_governance.entitlement_management_assignments (
id,
customExtensionCalloutInstances,
expiredDateTime,
schedule,
state,
status,
accessPackage,
assignmentPolicy,
target
)
SELECT 
'{{ id }}',
'{{ customExtensionCalloutInstances }}',
'{{ expiredDateTime }}',
'{{ schedule }}',
'{{ state }}',
'{{ status }}',
'{{ accessPackage }}',
'{{ assignmentPolicy }}',
'{{ target }}'
RETURNING
id,
accessPackage,
assignmentPolicy,
customExtensionCalloutInstances,
expiredDateTime,
schedule,
state,
status,
target
;

UPDATE examples​

No description available.

UPDATE entra_id.identity_governance.entitlement_management_assignments
SET 
id = '{{ id }}',
customExtensionCalloutInstances = '{{ customExtensionCalloutInstances }}',
expiredDateTime = '{{ expiredDateTime }}',
schedule = '{{ schedule }}',
state = '{{ state }}',
status = '{{ status }}',
accessPackage = '{{ accessPackage }}',
assignmentPolicy = '{{ assignmentPolicy }}',
target = '{{ target }}'
WHERE 
access_package_assignment_id = '{{ access_package_assignment_id }}' --required
RETURNING
id,
accessPackage,
assignmentPolicy,
customExtensionCalloutInstances,
expiredDateTime,
schedule,
state,
status,
target;

DELETE examples​

No description available.

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

Lifecycle Methods​

In Microsoft Entra entitlement management, callers can automatically reevaluate and enforce an accessPackageAssignment object of a user’s assignments for a specific access package. The state of the access package assignment must be Delivered for the administrator to reprocess the user's assignment. Only admins with the Access Package Assignment Manager role, or higher, in Microsoft Entra entitlement management can perform this action.

EXEC entra_id.identity_governance.entitlement_management_assignments.reprocess 
@access_package_assignment_id='{{ access_package_assignment_id }}' --required
;