accessPackageAssignment resource type

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

In Microsoft Entra Entitlement Management, an access package assignment is an assignment of an access package to a particular subject, for a period of time. For example, an access package assignment can state that user Alice has been assigned access via the access package Sales for the period January 2019 through July 2019.

Methods

Method	Return Type	Description
List accessPackageAssignments	accessPackageAssignment collection	Retrieve a list of accessPackageAssignment objects.
filterByCurrentUser	accessPackageAssignment collection	Retrieve the list of accessPackageAssignment objects filtered on the signed-in user.
reprocess	None	Automatically reevaluate and enforce a user’s assignments for a specific access package.
additionalAccess	accessPackageAssignment collection	Retrieve the list of accessPackageAssignment objects for users who have assignments to incompatible access packages.

Note

To create or remove an access package assignment for a user, use the create an accessPackageAssignmentRequest

Properties

Property	Type	Description
accessPackageId	String	The identifier of the access package. Read-only.
assignmentPolicyId	String	The identifier of the access package assignment policy. Read-only.
assignmentState	String	The state of the access package assignment. Possible values are Delivering, Delivered, or Expired. Read-only. Supports $filter (eq).
assignmentStatus	String	More information about the assignment lifecycle. Possible values include Delivering, Delivered, NearExpiry1DayNotificationTriggered, or ExpiredNotificationTriggered. Read-only.
catalogId	String	The identifier of the catalog containing the access package. Read-only.
customExtensionCalloutInstances	customExtensionCalloutInstance collection	Information about all the custom extension calls that were made during the access package assignment workflow.
expiredDateTime	DateTimeOffset	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
id	String	Read-only.
isExtended	Boolean	Indicates whether the access package assignment is extended. Read-only.
targetId	String	The ID of the subject with the assignment. Read-only.
schedule	requestSchedule	When the access assignment is to be in place. Read-only.

Relationships

Relationship	Type	Description
accessPackage	accessPackage	Read-only. Nullable. Supports $filter (eq) on the id property and $expand query parameters.
accessPackageAssignmentPolicy	accessPackageAssignmentPolicy	Read-only. Nullable. Supports $filter (eq) on the id property
accessPackageAssignmentResourceRoles	accessPackageAssignmentResourceRole collection	The resource roles delivered to the target user for this assignment. Read-only. Nullable.
target	accessPackageSubject	The subject of the access package assignment. Read-only. Nullable. Supports $expand. Supports $filter (eq) on objectId.

JSON representation

The following is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.accessPackageAssignment",
  "id": "String (identifier)",
  "catalogId": "String",
  "accessPackageId": "String",
  "assignmentPolicyId": "String",
  "targetId": "String",
  "assignmentStatus": "String",
  "assignmentState": "String",
  "isExtended": "Boolean",
  "expiredDateTime": "String (timestamp)",
  "schedule": {
    "@odata.type": "microsoft.graph.requestSchedule"
  },
  "customExtensionCalloutInstances": [
    {
      "@odata.type": "microsoft.graph.customExtensionCalloutInstance"
    }
  ]
}