accessPackageAssignmentRequest 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 request is created by or on behalf of a user who wants to obtain an access package assignment. If the request is successful, with any necessary approvals, the user receives an access package assignment, and is the subject of that resulting access package assignment. Microsoft Entra ID also creates access package assignment requests automatically for tracking access removal.

Methods

Method	Return Type	Description
List assignmentRequests	accessPackageAssignmentRequest collection	Retrieve a list of accesspackageassignmentrequest objects.
Create accessPackageAssignmentRequest	accessPackageAssignmentRequest	Create a new accessPackageAssignmentRequest.
Get accessPackageAssignmentRequest	accessPackageAssignmentRequest	Read properties and relationships of an accessPackageAssignmentRequest object.
Delete accessPackageAssignmentRequest	None	Delete an accessPackageAssignmentRequest.
filterByCurrentUser	accessPackageAssignmentRequest collection	Retrieve the list of accessPackageAssignmentRequest objects filtered on the signed-in user.
cancel	accessPackageAssignmentRequest collection	Cancel an accessPackageAssignmentRequest object that is in a cancellable state.
reprocess	None	Automatically retry a user's request for access to an access package.
List accessPackageAssignmentRequests	accessPackageAssignmentRequest collection	Retrieve a list of accesspackageassignmentrequest objects. This API will be retired soon. Use the List assignmentRequests API instead.
Create accessPackageAssignmentRequest	accessPackageAssignmentRequest	Create a new accessPackageAssignmentRequest. This API will be retired soon. Use the Create accessPackageAssignmentRequest API instead.

Properties

Property	Type	Description
completedDate	DateTimeOffset	The date of the end of processing, either successful or failure, of a request. 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.
createdDateTime	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.
customExtensionCalloutInstances	customExtensionCalloutInstance collection	Information about all the custom extension calls that were made during the access package assignment request workflow.
customExtensionHandlerInstances	customExtensionHandlerInstance collection	A collection of custom workflow extension instances being run on an assignment request. Read-only.
id	String	Read-only.
isValidationOnly	Boolean	True if the request is not to be processed for assignment.
justification	String	The requestor's supplied justification.
requestState	String	One of PendingApproval, Canceled, Denied, Delivering, Delivered, PartiallyDelivered, DeliveryFailed, Submitted or Scheduled. Read-only.
requestStatus	String	More information on the request processing status. Read-only.
requestType	String	One of UserAdd, UserExtend, UserUpdate, UserRemove, AdminAdd, AdminRemove or SystemRemove. A request from the user themselves would have requestType of UserAdd, UserUpdate or UserRemove. Read-only.
schedule	requestSchedule	The range of dates that access is to be assigned to the requestor. Read-only.
answers	accessPackageAnswer collection	Answers provided by the requestor to accessPackageQuestions asked of them at the time of request.
verifiedCredentialsData	verifiedCredentialData collection	The details of the verifiable credential that was presented by the requestor, such as the issuer and claims. Read-only.

Relationships

Relationship	Type	Description
accessPackage	accessPackage	The access package associated with the accessPackageAssignmentRequest. An access package defines the collections of resource roles and the policies for how one or more users can get access to those resources. Read-only. Nullable. Supports $expand.
accessPackageAssignment	accessPackageAssignment	For a requestType of UserAdd or AdminAdd, this is an access package assignment requested to be created. For a requestType of UserRemove, AdminRemove or SystemRemove, this has the id property of an existing assignment to be removed. Supports $expand.
requestor	accessPackageSubject	The subject who requested or, if a direct assignment, was assigned. Read-only. Nullable. Supports $expand.

JSON representation

The following is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.accessPackageAssignmentRequest",
  "id": "String (identifier)",
  "requestType": "String",
  "requestState": "String",
  "requestStatus": "String",
  "isValidationOnly": "Boolean",
  "createdDateTime": "String (timestamp)",
  "completedDate": "String (timestamp)",
  "expirationDateTime": "String (timestamp)",
  "justification": "String",
  "schedule": {
    "@odata.type": "microsoft.graph.requestSchedule"
  },
  "answers": [
    {
      "@odata.type": "microsoft.graph.accessPackageAnswerString"
    }
  ],
  "customExtensionHandlerInstances": [
    {
      "@odata.type": "microsoft.graph.customExtensionHandlerInstance"
    }
  ],
  "customExtensionCalloutInstances": [
    {
      "@odata.type": "microsoft.graph.customExtensionCalloutInstance"
    }
  ],
  "verifiedCredentialsData": [
    {
      "@odata.type": "microsoft.graph.verifiedCredentialData"
    }
  ]
}