Webex · Schema

UsersListItem

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
locationId string Target location for the user moves.
validate boolean Set to `true` to validate the user move; this option is not supported for multiple users. Set to `false` to perform the user move.
users array List of users to be moved.
View JSON Schema on GitHub

JSON Schema

webex-userslistitem-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UsersListItem",
  "title": "UsersListItem",
  "type": "object",
  "required": [
    "locationId",
    "validate",
    "users"
  ],
  "properties": {
    "locationId": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA",
      "description": "Target location for the user moves."
    },
    "validate": {
      "type": "boolean",
      "description": "Set to `true` to validate the user move; this option is not supported for multiple users. Set to `false` to perform the user move."
    },
    "users": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/UserItem"
      },
      "description": "List of users to be moved."
    }
  }
}