accessPackageAssignment resource type

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported.

In Azure AD 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 could state that user 'Alice' has the 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.

Note: You can't use a method to create or remove an access package assignment. Instead, a client that wants to request an access package assignment for a user, or remove an access package assignment from a user, can 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. Possible values are Delivered or Expired. Read-only.
assignmentStatus String Read-only.
catalogId String The identifier of the catalog containing the access package. Read-only.
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 would look like this: '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.

Relationships

Relationship Type Description
accessPackage accessPackage Read-only. Nullable.
accessPackageAssignmentPolicy accessPackageAssignmentPolicy Read-only. Nullable.
accessPackageAssignmentResourceRoles accessPackageAssignmentResourceRole collection Read-only. Nullable.
target accessPackageSubject The subject of the access package assignment. Read-only. Nullable.

JSON representation

The following is a JSON representation of the resource.

{
            "id": "9bdae7b4-6ece-487b-9eb8-9679dbd67aa2",
            "catalogId": "cc30dc98-6d3c-4fa0-bed8-fd76d0efd993",
            "accessPackageId": "e3f47362-993f-4fcb-8a38-532ffca16150",
            "assignmentPolicyId": "63ebd106-8116-40e7-a0ab-01ae475d11bb",
            "targetId": "ab4291f6-66b7-42bf-b597-a05b29414f5c",
            "assignmentStatus": "ExpiredNotificationTriggered",
            "assignmentState": "Expired",
            "isExtended": false,
            "expiredDateTime": "2019-04-25T23:45:40.42Z"
}