Manage customer accounts - Get Licenses

Service:

Partner Center Rest

API Version:

v1

GET https://api.partnercenter.microsoft.com/v1/customers/{customer_id}/users/{user_id}/licenses

With optional parameters:

GET https://api.partnercenter.microsoft.com/v1/customers/{customer_id}/users/{user_id}/licenses?licenseGroupIds={licenseGroupIds}

URI Parameters

Name	In	Required	Type	Description
customer_id	path	True	string	Customer tenant id.
user_id	path	True	string	The user id or user principal name of a user for get assigned licenses.
licenseGroupIds	query		string[]	license group ids (ex: "Group1" which means AAD products, "Group2" which means MDollar products).

Request Header

Name	Required	Type	Description
Authorization	True	string	Authorization Bearer token
ms-correlationid		string	Used for tracking requests internally. If a ms-correlationid is not provided, the server will generate a new one for each request
ms-cv		string	Used for tracking requests internally. If a ms-cv is not provided, the server will generate a new one for each request
ms-requestid		string	Used for idempotency of requests. If a ms-requestid is not provided, the server will generate a new one for each request

Responses

Name	Type	Description
200 OK	Microsoft.Partner.Providers.Contracts.V1.License	The request was successful. The response body contains the list of licenses. Media Types: "application/json", "text/json", "application/xml", "text/xml"

Definitions

Name	Description
Microsoft.Partner.Core.Collections.ResourceAttributes
Microsoft.Partner.Providers.Contracts.V1.License
Microsoft.Partner.Providers.Contracts.V1.ProductSku
Microsoft.Partner.Providers.Contracts.V1.ServicePlan

Microsoft.Partner.Core.Collections.ResourceAttributes

Name	Type	Description
etag	string
objectType	string

Microsoft.Partner.Providers.Contracts.V1.License

Name	Type	Description
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
productSku	Microsoft.Partner.Providers.Contracts.V1.ProductSku
servicePlans	Microsoft.Partner.Providers.Contracts.V1.ServicePlan[]

Microsoft.Partner.Providers.Contracts.V1.ProductSku

Name	Type	Description
id	string
licenseGroupId	enum: group1 group2 group3 none
name	string
skuPartNumber	string
targetType	string

Microsoft.Partner.Providers.Contracts.V1.ServicePlan

Name	Type	Description
capabilityStatus	string
displayName	string
id	string
serviceName	string
targetType	string