Cisco Webex · Schema

Cisco Webex Person

Represents a user in the Webex platform including profile information, contact details, roles, and licenses.

CollaborationCommunicationsMeetingsMessagingTeamsVideo Conferencing

Properties

Name Type Description
id string Unique identifier for the person.
emails array Email addresses associated with the person.
phoneNumbers array Phone numbers for the person.
sipAddresses array SIP addresses of the person.
extension string Webex Calling extension number.
locationId string Location ID for Webex Calling.
displayName string Full display name of the person.
nickName string Nickname of the person.
firstName string First name of the person.
lastName string Last name of the person.
avatar string URL to the person's avatar image.
orgId string Organization ID the person belongs to.
roles array Role IDs assigned to the person.
licenses array License IDs assigned to the person.
department string Department of the person.
manager string Manager name of the person.
managerId string Person ID of the manager.
title string Job title of the person.
addresses array Physical addresses of the person.
created string Date and time the person was created.
lastModified string Date and time the person was last modified.
timezone string Time zone of the person in IANA format.
lastActivity string Date and time of the person's last activity.
siteUrls array Webex site URLs associated with the person.
status string Current presence status of the person.
type string Type of the person account.
invitePending boolean Whether the invite is pending acceptance.
loginEnabled boolean Whether the person's login is enabled.
View JSON Schema on GitHub

JSON Schema

cisco-webex-person-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://developer.webex.com/schemas/person.json",
  "title": "Cisco Webex Person",
  "description": "Represents a user in the Webex platform including profile information, contact details, roles, and licenses.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the person."
    },
    "emails": {
      "type": "array",
      "description": "Email addresses associated with the person.",
      "items": {
        "type": "string",
        "format": "email"
      }
    },
    "phoneNumbers": {
      "type": "array",
      "description": "Phone numbers for the person.",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "Phone number type (e.g., work, mobile)."
          },
          "value": {
            "type": "string",
            "description": "Phone number value."
          }
        }
      }
    },
    "sipAddresses": {
      "type": "array",
      "description": "SIP addresses of the person.",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string"
          },
          "value": {
            "type": "string"
          },
          "primary": {
            "type": "boolean"
          }
        }
      }
    },
    "extension": {
      "type": "string",
      "description": "Webex Calling extension number."
    },
    "locationId": {
      "type": "string",
      "description": "Location ID for Webex Calling."
    },
    "displayName": {
      "type": "string",
      "description": "Full display name of the person."
    },
    "nickName": {
      "type": "string",
      "description": "Nickname of the person."
    },
    "firstName": {
      "type": "string",
      "description": "First name of the person."
    },
    "lastName": {
      "type": "string",
      "description": "Last name of the person."
    },
    "avatar": {
      "type": "string",
      "format": "uri",
      "description": "URL to the person's avatar image."
    },
    "orgId": {
      "type": "string",
      "description": "Organization ID the person belongs to."
    },
    "roles": {
      "type": "array",
      "description": "Role IDs assigned to the person.",
      "items": {
        "type": "string"
      }
    },
    "licenses": {
      "type": "array",
      "description": "License IDs assigned to the person.",
      "items": {
        "type": "string"
      }
    },
    "department": {
      "type": "string",
      "description": "Department of the person."
    },
    "manager": {
      "type": "string",
      "description": "Manager name of the person."
    },
    "managerId": {
      "type": "string",
      "description": "Person ID of the manager."
    },
    "title": {
      "type": "string",
      "description": "Job title of the person."
    },
    "addresses": {
      "type": "array",
      "description": "Physical addresses of the person.",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string"
          },
          "streetAddress": {
            "type": "string"
          },
          "locality": {
            "type": "string"
          },
          "region": {
            "type": "string"
          },
          "postalCode": {
            "type": "string"
          },
          "country": {
            "type": "string"
          }
        }
      }
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time the person was created."
    },
    "lastModified": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time the person was last modified."
    },
    "timezone": {
      "type": "string",
      "description": "Time zone of the person in IANA format."
    },
    "lastActivity": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time of the person's last activity."
    },
    "siteUrls": {
      "type": "array",
      "description": "Webex site URLs associated with the person.",
      "items": {
        "type": "string"
      }
    },
    "status": {
      "type": "string",
      "description": "Current presence status of the person.",
      "enum": ["active", "call", "DoNotDisturb", "inactive", "meeting", "OutOfOffice", "pending", "presenting", "unknown"]
    },
    "type": {
      "type": "string",
      "description": "Type of the person account.",
      "enum": ["person", "bot", "appuser"]
    },
    "invitePending": {
      "type": "boolean",
      "description": "Whether the invite is pending acceptance."
    },
    "loginEnabled": {
      "type": "boolean",
      "description": "Whether the person's login is enabled."
    }
  },
  "required": ["id", "emails", "displayName"]
}