Webex · Schema

RedSkyServiceSettingsObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
enabled	boolean	`true` if the service is enabled.
companyId	string	The RedSky company ID, which can be retrieved from the RedSky portal.
secret	string	The company secret key, which can be found in the RedSky portal.
externalTenantEnabled	boolean	`true` if the RedSky reseller customer is not under a Cisco account.
email	string	The email for the RedSky account. `email` is required if `externalTenantEnabled` is true.
password	string	The password for the RedSky account. `password` is required if `externalTenantEnabled` is true.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RedSkyServiceSettingsObject",
  "title": "RedSkyServiceSettingsObject",
  "type": "object",
  "required": [
    "enabled"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "example": true,
      "description": "`true` if the service is enabled."
    },
    "companyId": {
      "type": "string",
      "example": "a5e5808f-34ac-4ed0-b8f3-2416bc4cb785",
      "description": "The RedSky company ID, which can be retrieved from the RedSky portal."
    },
    "secret": {
      "type": "string",
      "example": "qwEr4%2d",
      "description": "The company secret key, which can be found in the RedSky portal."
    },
    "externalTenantEnabled": {
      "type": "boolean",
      "example": true,
      "description": "`true` if the RedSky reseller customer is not under a Cisco account."
    },
    "email": {
      "type": "string",
      "example": "[email protected]",
      "description": "The email for the RedSky account. `email` is required if `externalTenantEnabled` is true."
    },
    "password": {
      "type": "string",
      "example": "Test@123",
      "description": "The password for the RedSky account. `password` is required if `externalTenantEnabled` is true."
    }
  }
}