Webex · Schema

UserLicensesResponse

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
orgId string The ID of the organization to which this user belongs.
personId string A unique identifier for the user.
email string The email address of this user.
licenses array An array of license strings that are assigned to this user.
siteUrls array An array of `siteUrls` and their `accountType` that are assigned to this user.
pendingLicenses array An array of license strings that are in pending state. This is only applicable to users outside the organization.
pendingSiteUrls array An array of `siteUrls` and their `accountType` that are in pending state. This is only applicable to users outside the organization.
View JSON Schema on GitHub

JSON Schema

webex-userlicensesresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserLicensesResponse",
  "title": "UserLicensesResponse",
  "type": "object",
  "properties": {
    "orgId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
      "description": "The ID of the organization to which this user belongs."
    },
    "personId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
      "description": "A unique identifier for the user."
    },
    "email": {
      "type": "string",
      "example": "[email protected]",
      "description": "The email address of this user."
    },
    "licenses": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh,Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi,Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LTIzNDItMGY0NTU2YWRlZXJm"
      },
      "description": "An array of license strings that are assigned to this user."
    },
    "siteUrls": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SiteResponse"
      },
      "description": "An array of `siteUrls` and their `accountType` that are assigned to this user."
    },
    "pendingLicenses": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYWJj,Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWFiY2Rl"
      },
      "description": "An array of license strings that are in pending state. This is only applicable to users outside the organization."
    },
    "pendingSiteUrls": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SiteResponse"
      },
      "description": "An array of `siteUrls` and their `accountType` that are in pending state. This is only applicable to users outside the organization."
    }
  }
}