Edit

accessPackageAssignment resource type

  • Article

Namespace: microsoft.graph

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.
Get accessPackageAssignment accessPackageAssignment Retrieve a accessPackageAssignment object.
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 a list of accessPackageAssignment objects indicating potential separation of duties conflicts or access to incompatible access packages.

Note

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

Properties

Property Type Description
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. Read-only.
id String Read-only.
schedule entitlementManagementSchedule When the access assignment is to be in place. Read-only.
state accessPackageAssignmentState The state of the access package assignment. The possible values are: delivering, partiallyDelivered, delivered, expired, deliveryFailed, unknownFutureValue. Read-only. Supports $filter (eq).
status String More information about the assignment lifecycle. Possible values include Delivering, Delivered, NearExpiry1DayNotificationTriggered, or ExpiredNotificationTriggered. Read-only.

Relationships

Relationship Type Description
accessPackage accessPackage Read-only. Nullable. Supports $filter (eq) on the id property and $expand query parameters.
target accessPackageSubject The subject of the access package assignment. Read-only. Nullable. Supports $expand. Supports $filter (eq) on objectId.
assignmentPolicy accessPackageAssignmentPolicy Read-only. Supports $filter (eq) on the id property and $expand query parameters.

JSON representation

The following is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.accessPackageAssignment",
  "expiredDateTime": "String (timestamp)",
  "id": "String (identifier)",
  "schedule": {
    "@odata.type": "microsoft.graph.entitlementManagementSchedule"
  },
  "state": "String",
  "status": "String"
}