accessPackageAssignmentRequest resource type
Namespace: microsoft.graph
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 | accessPackageAssignmentRequest collection | Retrieve a list of accesspackageassignmentrequest objects. |
| Create | accessPackageAssignmentRequest | Creates a new accessPackageAssignmentRequest object. |
| Get | accessPackageAssignmentRequest | Read properties and relationships of an accessPackageAssignmentRequest object. |
| Delete | None | Delete an accessPackageAssignmentRequest. |
| Cancel | accessPackageAssignmentRequest collection | Cancel an accessPackageAssignmentRequest object that is in a cancelable state. |
| Filter by current user | accessPackageAssignmentRequest collection | Retrieve the list of accessPackageAssignmentRequest objects filtered on the signed-in user. |
| Reprocess | None | Automatically retry a user’s request for access to an access package. |
| Resume | None | Resume a user's access package request after waiting for a callback from a custom extension. |
Properties
| Property | Type | Description |
|---|---|---|
| answers | accessPackageAnswer collection | Answers provided by the requestor to accessPackageQuestions asked of them at the time of request. |
| completedDateTime | 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. |
| customExtensionCalloutInstances | customExtensionCalloutInstance collection | Information about all the custom extension calls that were made during the access package assignment workflow. |
| 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. Supports $filter. |
| id | String | Read-only. |
| requestType | accessPackageRequestType | The type of the request. The possible values are: notSpecified, userAdd, UserExtend, userUpdate, userRemove, adminAdd, adminUpdate, adminRemove, systemAdd, systemUpdate, systemRemove, onBehalfAdd (not supported), unknownFutureValue. Requests from the user have a requestType of userAdd, userUpdate, or userRemove. This property can't be changed once set. |
| schedule | entitlementManagementSchedule | The range of dates that access is to be assigned to the requestor. This property can't be changed once set, but a new schedule for an assignment can be included in another userUpdate or UserExtend or adminUpdate assignment request. |
| state | accessPackageRequestState | The state of the request. The possible values are: submitted, pendingApproval, delivering, delivered, deliveryFailed, denied, scheduled, canceled, partiallyDelivered, unknownFutureValue. Read-only. Supports $filter (eq). |
| status | String | More information on the request processing status. 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. |
| assignment | 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 JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.accessPackageAssignmentRequest",
"completedDateTime": "String (timestamp)",
"createdDateTime": "String (timestamp)",
"id": "String (identifier)",
"requestType": "String",
"schedule": {
"@odata.type": "microsoft.graph.entitlementManagementSchedule"
},
"state": "String",
"status": "String",
"answers": [
{
"@odata.type": "microsoft.graph.accessPackageAnswerString"
}
]
}