Licenses - Get License Details | Webex for Developers

Get License Details

Shows details for a license, by ID.

Specify the license ID in the licenseId parameter in the URI. Use the optional query parameter includeAssignedTo to get a list of all objects that are assigned with the license. The objects include but not limited to, users including external users. Long result sets will be split into pages.

Response properties that are not applicable to the license will not be present in the response.

GET/v1/licenses/{licenseId}

URI Parameters

licenseId

stringrequired

The unique identifier for the license.

Query Parameters

includeAssignedTo

string

The type of object to whom the license is assigned to.

Possible values: user

string

List the next set of users. Applicable only if includeAssignedTo is populated.

limit

number

A limit on the number of users to be returned in the response. Applicable only if includeAssignedTo is populated. limit cannot be more than 300.

Default: 300

Response Properties

string

A unique identifier for the license.

name

string

Name of the licensed feature.

totalUnits

number

Total number of license units allocated.

consumedUnits

number

Total number of license units consumed.

consumedByUsers

number

Total number of license units consumed by users.

consumedByWorkspaces

number

Total number of license units consumed by workspaces.

subscriptionId

string

The subscription ID associated with this license. This ID is used in other systems, such as Webex Control Hub.

siteUrl

string

The Webex Meetings site associated with this license.

siteType

enum

The type of site associated with this license.

Control Hub managed site

string

The site is managed by Webex Control Hub.

Linked site

string

The site is a linked site.

Site Admin managed site

string

The site is managed by Site Administration.

users

array[Users]

A list of users to whom the license is assigned to.

string

A unique identifier for the user.

type

enum

Indicates if the user is internal or external to the organization.

INTERNAL

string

User resides in the license-owned organization.

EXTERNAL

string

User resides outside the license-owned organization.

displayName

string

The full name of the user.

string

Email address of the user.

Response Codes

The list below describes the common success and error responses you should expect from the API.

Code	Status	Description
200	OK	Successful request with body content.
201	Created	The request has succeeded and has led to the creation of a resource.
202	Accepted	The request has been accepted for processing.
204	No Content	Successful request without body content.
400	Bad Request	The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401	Unauthorized	Authentication credentials were missing or incorrect.
403	Forbidden	The request is understood, but it has been refused or access is not allowed.
404	Not Found	The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405	Method Not Allowed	The request was made to a resource using an HTTP request method that is not supported.
409	Conflict	The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410	Gone	The requested resource is no longer available.
415	Unsupported Media Type	The request was made to a resource without specifying a media type or used a media type that is not supported.
423	Locked	The requested resource is temporarily unavailable. A `Retry-After` header may be present that specifies how many seconds you need to wait before attempting the request again.
428	Precondition Required	File(s) cannot be scanned for malware and need to be force downloaded.
429	Too Many Requests	Too many requests have been sent in a given amount of time and the request has been rate limited. A `Retry-After` header should be present that specifies how many seconds you need to wait before a successful request can be made.
500	Internal Server Error	Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502	Bad Gateway	The server received an invalid response from an upstream server while processing the request. Try again later.
503	Service Unavailable	Server is overloaded with requests. Try again later.
504	Gateway Timeout	An upstream server failed to respond on time. If your query uses `max` parameter, please try to reduce it.

GET

/v1/licenses/{?includeAssignedTo,next,limit}

Header

Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Query Parameters

includeAssignedTo
string
The type of object to whom the license is assigned to.
next
string
List the next set of users. Applicable only if `includeAssignedTo` is populated.
limit
number
A limit on the number of users to be returned in the response. Applicable only if `includeAssignedTo` is populated. limit cannot be more than 300.

https://webexapis.com/v1/licenses/Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh?includeAssignedTo=%5Bobject%20Object%5D&next=Y2lzY29zcGFyazovL3VzL0xJQ0VOU0VfVVNFUl9QQUdJTkcvT1RaaFltTXlZV0V0TTJSall5MHhNV1UxTFdFeE5USXRabVV6TkRneE9XTmtZemxo&limit=10

200 / OK

{
  "id": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
  "name": "Meeting - Webex Meeting Center",
  "totalUnits": 50,
  "consumedUnits": 5,
  "consumedByUsers": 5,
  "consumedByWorkspaces": 0,
  "subscriptionId": "Sub-hydraOct26a",
  "siteUrl": "site1-example.webex.com",
  "siteType": "Control Hub managed site",
  "users": [
    {
      "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
      "type": "INTERNAL",
      "displayName": "John Andersen",
      "email": "john.andersen@example.com"
    }
  ]
}