Webex · Schema

Users

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string A unique identifier for the user.
type string Indicates if the user is internal or external to the organization. * `INTERNAL` - User resides in the license-owned organization. * `EXTERNAL` - User resides outside the license-owned organization.
displayName string The full name of the user.
email string Email address of the user.
View JSON Schema on GitHub

JSON Schema

webex-users-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Users",
  "title": "Users",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
      "description": "A unique identifier for the user."
    },
    "type": {
      "type": "string",
      "enum": [
        "INTERNAL",
        "EXTERNAL"
      ],
      "description": "Indicates if the user is internal or external to the organization.\n * `INTERNAL` - User resides in the license-owned organization.\n * `EXTERNAL` - User resides outside the license-owned organization.\n"
    },
    "displayName": {
      "type": "string",
      "example": "John Andersen",
      "description": "The full name of the user."
    },
    "email": {
      "type": "string",
      "example": "[email protected]",
      "description": "Email address of the user."
    }
  }
}