License

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/License",
  "title": "License",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
      "description": "A unique identifier for the license."
    },
    "name": {
      "type": "string",
      "example": "Meeting - Webex Meeting Center",
      "description": "Name of the licensed feature."
    },
    "totalUnits": {
      "type": "number",
      "example": 50,
      "description": "Total number of license units allocated."
    },
    "consumedUnits": {
      "type": "number",
      "example": 5,
      "description": "Total number of license units consumed."
    },
    "consumedByUsers": {
      "type": "number",
      "example": 5,
      "description": "Total number of license units consumed by users."
    },
    "consumedByWorkspaces": {
      "type": "number",
      "description": "Total number of license units consumed by workspaces."
    },
    "subscriptionId": {
      "type": "string",
      "example": "Sub-hydraOct26a",
      "description": "The subscription ID associated with this license. This ID is used in other systems, such as Webex Control Hub."
    },
    "siteUrl": {
      "type": "string",
      "example": "site1-example.webex.com",
      "description": "The Webex Meetings site associated with this license."
    },
    "siteType": {
      "type": "string",
      "enum": [
        "Control Hub managed site",
        "Linked site",
        "Site Admin managed site"
      ],
      "description": "The type of site associated with this license.\n * `Control Hub managed site` - The site is managed by Webex Control Hub.\n * `Linked site` - The site is a linked site.\n * `Site Admin managed site` - The site is managed by Site Administration.\n"
    }
  }
}