List assignmentRequests
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, retrieve a list of accessPackageAssignmentRequest objects. The resulting list includes all the assignment requests, current and well as expired, that the caller has access to read, across all catalogs and access packages.
This API is available in the following national cloud deployments.
Global service | US Government L4 | US Government L5 (DOD) | China operated by 21Vianet |
---|---|---|---|
✅ | ❌ | ❌ | ❌ |
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
Permission type | Least privileged permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | EntitlementManagement.Read.All | EntitlementManagement.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | EntitlementManagement.Read.All | EntitlementManagement.ReadWrite.All |
Tip
In delegated scenarios with work or school accounts, the signed-in user must also be assigned an administrator role with supported role permissions through one of the following options:
- A role in the Entitlement Management system where the least privileged roles are:
- Catalog reader. This is the least privileged option
- Catalog creator
- Access package manager
- More privileged Microsoft Entra roles supported for this operation:
- Security Reader
- Global Reader
- Compliance Administrator
- Security Administrator
- Identity Governance Administrator
In app-only scenarios, the calling app can be assigned one of the preceding supported roles instead of the EntitlementManagement.Read.All
application permission. The Catalog reader role is less privileged than the EntitlementManagement.Read.All
application permission.
For more information, see Delegation and roles in entitlement management and how to delegate access governance to access package managers in entitlement management.
HTTP request
GET /identityGovernance/entitlementManagement/assignmentRequests
Optional query parameters
This method supports the $select
, $expand
and $filter
OData query parameters to help customize the response. Not all attributes of an accessPackageAssignmentRequest are supported for filtering.
If the user or application only has permissions within a specific catalog or catalogs, you must include in the query a filter which specifies an access package, such as $expand=accessPackage&$filter=accessPackage/id eq '9bbe5f7d-f1e7-4eb1-a586-38cdf6f8b1ea'
.
Example scenarios for using query parameters
- To retrieve requests created after a specific date, include
$filter=createdDateTime gt 2022-04-01T00:00:01Z
in the query. - To retrieve the access package of each request, include
$expand=accessPackage
in the query. - To retrieve the resulting assignment, include
$expand=assignment
in the query. - To obtain more details on the requestor, include
$expand=requestor
in the query.
For general information, see OData query parameters.
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. |
Request body
Don't supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and a collection of accessPackageAssignmentRequest objects in the response body.
Examples
Request
GET https://graph.microsoft.com/beta/identityGovernance/entitlementManagement/assignmentRequests
Response
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-Type: application/json
{
"value": [
{
"id": "7999249e-249e-7999-9e24-99799e249979",
"requestType": "userAdd",
"state": "delivered",
"status": "Delivered",
"createdDateTime": "2019-10-25T22:55:11.623Z",
"completedDateTime": "2019-10-26T22:55:11.623Z",
"schedule": {
"@odata.type": "microsoft.graph.entitlementManagementSchedule"
}
}
]
}