Webex · Schema

TriggerUserDirectorySyncResponse

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
userResponse object User Directory sync response
status string The Status of the operation being performed. * `ADD` - The external user is added in this sync * `UPDATE` - The external user is updated in this sync * `DELETE` - The external user is deleted in this
View JSON Schema on GitHub

JSON Schema

webex-triggeruserdirectorysyncresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TriggerUserDirectorySyncResponse",
  "title": "TriggerUserDirectorySyncResponse",
  "type": "object",
  "properties": {
    "userResponse": {
      "type": "object",
      "properties": {
        "userId": {
          "type": "string",
          "example": "[email protected]",
          "description": "The UserID of the user on Broadworks (A non-webex user)."
        },
        "firstName": {
          "type": "string",
          "example": "John",
          "description": "First name of the user on Broadworks."
        },
        "lastName": {
          "type": "string",
          "example": "Anderson",
          "description": "Last name of the user on Broadworks."
        },
        "extension": {
          "type": "string",
          "example": "4653",
          "description": "Extension of the user on Broadworks."
        },
        "number": {
          "type": "string",
          "example": "+35391884653",
          "description": "Phone number of the user on Broadworks."
        },
        "mobile": {
          "type": "string",
          "example": "+188-(2323)-(343)",
          "description": "Mobile number of the user on Broadworks."
        }
      },
      "description": "User Directory sync response"
    },
    "status": {
      "type": "string",
      "enum": [
        "ADD",
        "UPDATE",
        "DELETE",
        "NO_OPERATION"
      ],
      "description": "The Status of the operation being performed.\n * `ADD` - The external user is added in this sync\n * `UPDATE` - The external user is updated in this sync\n * `DELETE` - The external user is deleted in this sync\n * `NO_OPERATION` - No changes made on the external user in this sync\n"
    }
  }
}