List usageRights for user
Namespace: microsoft.graph.cloudLicensing
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.
Get a list of the usageRight objects granted to a user. This API returns details about licenses that are directly assigned to a user and those licenses transitively assigned through membership in licensed groups.
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) | User-UsageRight.Read | User-CloudLicensing.Read, User-CloudLicensing.Read.All, User-UsageRight.Read.All |
Delegated (personal Microsoft account) | Not supported. | Not supported. |
Application | Not supported. | Not supported. |
HTTP request
GET /me/cloudLicensing/usageRights
GET /users/{userId}/cloudLicensing/usageRights
Optional query parameters
This method supports the $select
and $filter
OData query parameters to help customize the response. For general information, see OData query parameters.
The following examples show how to get usage rights information for users based on specific filters:
GET /users/48fbdf70-9e09-40df-9dbe-17af483ab113/cloudLicensing/usageRights?$filter=skuId eq 639dec6b-bb19-468b-871c-c5c441c4b0cb
GET /users/48fbdf70-9e09-40df-9dbe-17af483ab113/cloudLicensing/usageRights?$filter=skuId in (639dec6b-bb19-468b-871c-c5c441c4b0cb, a403ebcc-fae0-4ca2-8c8c-7a907fd6c235)
GET /users/48fbdf70-9e09-40df-9dbe-17af483ab113/cloudLicensing/usageRights?$filter=services/any(c:c/planId eq 113feb6c-3fe4-4440-bddc-54d774bf0318)
GET /users/48fbdf70-9e09-40df-9dbe-17af483ab113/cloudLicensing/usageRights?$filter=services/any(c:c/planId in (113feb6c-3fe4-4440-bddc-54d774bf0318, 2049e525-b859-401b-b2a0-e0a31c4b1fe4))
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
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 microsoft.graph.cloudLicensing.usageRight objects in the response body.
Examples
Example 1: Get all usage rights for a user
The following example shows how to get all usage rights granted to a user.
Request
The following example shows a request.
GET https://graph.microsoft.com/beta/users/48fbdf70-9e09-40df-9dbe-17af483ab113/cloudLicensing/usageRights
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-Type: application/json
{
"value": [
{
"@odata.type": "#microsoft.graph.cloudLicensing.usageRight",
"id": "1e373a1d-1f05-28cf-bfc0-ee0ecfd3db15",
"skuId": "639dec6b-bb19-468b-871c-c5c441c4b0cb",
"skuPartNumber": "Microsoft_365_Copilot",
"services": [
{
"@odata.type": "microsoft.graph.cloudLicensing.service",
"assignableTo": "user,group",
"planId": "fe6c28b3-d468-44ea-bbd0-a10a5167435c",
"planName": "COPILOT_STUDIO_IN_COPILOT_FOR_M365"
}
]
}
]
}
Example 2: Get all usage rights for a user with a specific service plan
The following example shows how to get all usage rights granted to a user for a specific service plan.
Request
The following example shows a request.
GET https://graph.microsoft.com/beta/users/48fbdf70-9e09-40df-9dbe-17af483ab113/cloudLicensing/usageRights?$filter=services/any(c:c/planId eq 113feb6c-3fe4-4440-bddc-54d774bf0318)
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 200 OK
Content-Type: application/json
{
"value": [
{
"@odata.type": "#microsoft.graph.cloudLicensing.usageRight",
"id": "5bbc716a-f73f-4cc1-bf16-53d38b407b8f",
"skuId": "75398b2a-b060-4057-9ae2-9eb00ef68579",
"skuPartNumber": "Copilot_Pro",
"services": [
{
"@odata.type": "microsoft.graph.cloudLicensing.service",
"assignableTo": "user",
"planId": "113feb6c-3fe4-4440-bddc-54d774bf0318",
"planName": "EXCHANGE_S_FOUNDATION"
}
]
}
]
}