Licenses - Assign Licenses to Users

Assign Licenses to Users

Assign licenses and attendee siteUrls to existing users. Only an admin can assign licenses. Only existing users can be assigned a license. Assign meeting licenses to users outside your organization (Status will be pending until the user accepts the invite)

At least one of the following body parameters is required to assign license to the user: email, personId. For Calling license assignment, properties phoneNumber or extension are required. If phoneNumber is not provided then locationId is mandatory.

When assigning licenses and attendee siteUrls to a user who does not belong to the organization, the licenses and siteUrls remain in pending state until the user accepts them. The pendingLicenses and pendingSiteUrls are part of the response.

PATCH/v1/licenses/users

Body Parameters

string

Email address of the user.

personId

string

A unique identifier for the user.

orgId

string

The ID of the organization to which the licenses and siteUrls belong. If not specified, the organization ID from the OAuth token is used.

licenses

array[LicenseRequest]

An array of licenses to be assigned to the user.

stringrequired

A unique identifier for the license.

operation

enum

Operation type. The default operation is add if no operation is specified.

remove

string

Remove the license from the user

add

string

Assign the license to the user

properties

License Properties

Properties for the license. Either phoneNumber or extension are mandatory for assigning Webex Calling licenses. If phoneNumber is not provided then locationId is mandatory.

locationId

string

The ID of the location for this user. Applicable to Webex Calling license.

phoneNumber

string

Work phone number for the user. Applicable to Webex Calling license.

extension

string

Webex Calling extension of the user. Applicable to Webex Calling license.

siteUrls

array[SiteUrlsRequest]

An array of siteUrls to be assigned to the user.

siteUrl

stringrequired

Attendee access on the site.

accountType

enumrequired

Account type. Only attendee type is supported. For host account, remove attendee and assign the license on that site.

attendee

string

Attendee role on the siteUrl

operation

enum

Operation type. The default operation is add if no operation is specified.

remove

string

Remove the attendee role from the user.

add

string

Add the attendee role to the user.

Response Properties

orgId

string

The ID of the organization to which this user belongs.

personId

string

A unique identifier for the user.

string

The email address of this user.

licenses

array[string]

An array of license strings that are assigned to this user.

siteUrls

array[SiteResponse]

An array of siteUrls and their accountType that are assigned to this user.

siteUrl

string

siteUrl assigned to the user.

accountType

enum

Account Type of the site.

attendee

string

Attendee account on the site.

host

string

Host account on the site.

pendingLicenses

array[string]

An array of license strings that are in pending state. This is only applicable to users outside the organization.

pendingSiteUrls

array[SiteResponse]

An array of siteUrls and their accountType that are in pending state. This is only applicable to users outside the organization.

siteUrl

string

siteUrl assigned to the user.

accountType

enum

Account Type of the site.

attendee

string

Attendee account on the site.

host

string

Host account on the site.

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.

PATCH

/v1/licenses/users

Header

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

Body

email
string
Email address of the user.
personId
string
A unique identifier for the user.
orgId
string
The ID of the organization to which the licenses and siteUrls belong. If not specified, the organization ID from the OAuth token is used.
licenses
array
An array of licenses to be assigned to the user.
siteUrls
array
An array of siteUrls to be assigned to the user.

{
   "email": "john.andersen@example.com",
   "personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
   "orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
   "licenses": [
      {
         "id": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
         "operation": "add",
         "properties": {
            "locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzYzNzE1",
            "phoneNumber": "+14085267209",
            "extension": "133"
         }
      },
      {
         "id": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LTU2eTctMGY0NTU2YWRleWhu",
         "operation": "remove"
      },
      {
         "id": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LTIzNDItMGY0NTU2YWRlZXJm",
         "operation": "add"
      }
   ],
   "siteUrls": [
      {
         "siteUrl": "mysite.webex.com",
         "accountType": "attendee",
         "operation": "add"
      }
   ]
}

200 / OK

{
   "orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
   "personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
   "email": "john.andersen@example.com",
   "licenses": [
      "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
      "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi",
      "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LTIzNDItMGY0NTU2YWRlZXJm"
   ],
   "siteUrls": [
      {
         "siteUrl": "mysite.webex.com",
         "accountType": "attendee"
      },
      {
         "siteUrl": "myhostsite.webex.com",
         "accountType": "host"
      }
   ]
}