Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Solutions that embed Dragon Copilot should always check if the end user has permission to use the technology. Licenses take several forms; the license service abstracts the implementation details and returns an HTTP response indicating the user's license status.
Check a user's license
GET /licenses/customers/{customerId}/users/{userId}/products/{productId}?api-version=2&customerId={customerId}
Parameters
| Type | Name | Required | Description | Schema |
|---|---|---|---|---|
| URL | partnerId |
No | The Microsoft-defined identifier of the partner for whom a license is being checked. | String (uuid) |
| URL | customerId |
Yes | The Microsoft-defined identifier of the customer for whom a license is being checked. | String (uuid) |
| URL | userId |
Yes | The partner-defined identifier of the user for whom a license is being checked. | String |
| URL | productId |
Yes | The Microsoft-defined identifier of the product to check if the user has been assigned a license. See Product identifiers. | String (uuid) |
| Query | api-version |
Yes | The supported API version. Must be set to 2. | Integer (int32) |
| Query | customerId |
Yes | The Microsoft-defined identifier of the customer for whom the request is being made. | String (uuid) |
HTTP headers
| Name | Value |
|---|---|
Authorization |
Bearer <access token issued by your identity solution> |
Accept |
application/json |
Sample requests
Check if the user with the specified partner ID and customer ID is allowed to use Dragon Copilot embedded in the partner's application.
GET /licenses/partners/3fa85f64-5717-4562-b3fc-2c963f66afa6/customers/00000000-1111-2222-3333-444444444444/users/ext4321/products/4f939ade-287a-416d-8484-1e64013039dd?api-version=2&customerId=00000000-1111-2222-3333-444444444444
Check if the user with the specified customer ID is allowed to use Dragon Copilot embedded in the partner's application.
GET /licenses/customers/00000000-1111-2222-3333-444444444444/users/ext4321/products/4f939ade-287a-416d-8484-1e64013039dd?api-version=2&customerId=00000000-1111-2222-3333-444444444444
Response codes
| Code | Description | Links |
|---|---|---|
| 200 | Success. The specified user has a license for the specified product. Content: application/json |
No links |
| 400 | Bad request. Required validations aren't passed. | No links |
| 401 | Not authorized. The access token is missing or invalid. | No links |
| 403 | Forbidden. The caller isn't authorized to call this API. | No links |
| 404 | The specified user doesn't have a license for the specified product. | No links |
| 500 | Internal server error. Any other exceptional scenario where the application isn't able to complete the request. | No links |
Response body
{
"message": "OK"
}
Response body properties
| Name | Description | Schema |
|---|---|---|
message |
Success message | String |