Webex · Schema

ComplianceStatusResponse

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
orgStatus	object	The RedSky account configuration status for the organization.
complianceStatus	object	The RedSky account's compliance status.
companyId	string	The RedSky held token from the secret response.
redSkyOrgId	string	The RedSky organization ID for the organization which can be found in the RedSky portal.
adminExists	boolean	`true` if an Admin has been created in RedSky.
locationsStatus	object	Object that contains a list of locations, the `count` for the location list, and the `state` for the location that has completed the least amount of setup. Available if at least one location is exists

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ComplianceStatusResponse",
  "title": "ComplianceStatusResponse",
  "type": "object",
  "required": [
    "orgStatus",
    "complianceStatus"
  ],
  "properties": {
    "orgStatus": {
      "$ref": "#/components/schemas/OrgStatusEnum",
      "description": "The RedSky account configuration status for the organization."
    },
    "complianceStatus": {
      "$ref": "#/components/schemas/ComplianceStatusResponseEnum",
      "description": "The RedSky account's compliance status."
    },
    "companyId": {
      "type": "string",
      "example": "ddd1424c-5b48-433d-9bab-061cdfb84c90",
      "description": "The RedSky held token from the secret response."
    },
    "redSkyOrgId": {
      "type": "string",
      "example": "2ff43e05-af11-41ff-91b6-87a3b509f4z4",
      "description": "The RedSky organization ID for the organization which can be found in the RedSky portal."
    },
    "adminExists": {
      "type": "boolean",
      "example": true,
      "description": "`true` if an Admin has been created in RedSky."
    },
    "locationsStatus": {
      "$ref": "#/components/schemas/ComplianceStatusResponseLocationStatusObject",
      "description": "Object that contains a list of locations, the `count` for the location list, and the `state` for the location that has completed the least amount of setup. Available if at least one location is exists."
    }
  }
}