Webex · Schema

RedSkyGetObject

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. It will be displayed with data masked.
locationsEnabled boolean `true` if RedSky is enabled for any location.
View JSON Schema on GitHub

JSON Schema

webex-redskygetobject-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RedSkyGetObject",
  "title": "RedSkyGetObject",
  "type": "object",
  "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": "*****",
      "description": "The company secret key, which can be found in the RedSky portal. It will be displayed with data masked."
    },
    "locationsEnabled": {
      "type": "boolean",
      "example": true,
      "description": "`true` if RedSky is enabled for any location."
    }
  }
}