Webex · Schema

SettingsObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
settingName string Name of the setting retrieved. * `HIDE_WEBEX_APP` - Webex will continue to run but its windows will be closed by default. Users can still access Webex from the system tray on Windows or the Menu Bar o
level string Level at which the `settingName` has been set. * `GLOBAL` - `settingName` configured at the `GLOBAL` `level`. * `ORGANIZATION` - `settingName` configured at the `ORGANIZATION` `level`. * `GROUP` - `se
value boolean Either `true` or `false` for the respective `settingName` to be retrieved.
lastModified string The date and time when the respective `settingName` was last updated.
View JSON Schema on GitHub

JSON Schema

webex-settingsobject-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SettingsObject",
  "title": "SettingsObject",
  "type": "object",
  "required": [
    "settingName",
    "level",
    "value",
    "lastModified"
  ],
  "properties": {
    "settingName": {
      "type": "string",
      "enum": [
        "HIDE_WEBEX_APP",
        "PRESENCE_SYNC"
      ],
      "description": "Name of the setting retrieved.\n * `HIDE_WEBEX_APP` - Webex will continue to run but its windows will be closed by default. Users can still access Webex from the system tray on Windows or the Menu Bar on Mac.\n * `PRESENCE_SYNC` - Sync presence status between Microsoft Teams and Webex.\n"
    },
    "level": {
      "type": "string",
      "enum": [
        "GLOBAL",
        "ORGANIZATION",
        "GROUP",
        "PEOPLE"
      ],
      "description": "Level at which the `settingName` has been set.\n * `GLOBAL` - `settingName` configured at the `GLOBAL` `level`.\n * `ORGANIZATION` - `settingName` configured at the `ORGANIZATION` `level`.\n * `GROUP` - `settingName` configured at the `GROUP` `level`.\n * `PEOPLE` - `settingName` configured at the `PEOPLE` `level`.\n"
    },
    "value": {
      "type": "boolean",
      "example": true,
      "description": "Either `true` or `false` for the respective `settingName` to be retrieved."
    },
    "lastModified": {
      "type": "string",
      "example": "2024-02-24T07:21:23.494198Z",
      "description": "The date and time when the respective `settingName` was last updated."
    }
  }
}