Webex · Schema

NameObject

The components of the user's real name.

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
givenName string The given name of the user, or first name in most Western languages (e.g., "Sarah" given the full name "Ms. Sarah J Henderson, III").
familyName string The family name of the user, or last name in most Western languages (e.g., "Henderson" given the full name "Ms. Sarah J Henderson, III").
middleName string The middle name(s) of the user (e.g., "Jane" given the full name "Ms. Sarah J Henderson, III").
honorificPrefix string The honorific prefix(es) of the user, or title in most Western languages (e.g., "Ms." given the full name "Ms. Sarah J Henderson, III").
honorificSuffix string The honorific suffix(es) of the user, or suffix in most Western languages (e.g., "III" given the full name "Ms. Sarah J Henderson, III").
View JSON Schema on GitHub

JSON Schema

webex-nameobject-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/NameObject",
  "title": "NameObject",
  "type": "object",
  "description": "The components of the user's real name.",
  "properties": {
    "givenName": {
      "type": "string",
      "example": "Sarah",
      "description": "The given name of the user, or first name in most Western languages (e.g., \"Sarah\" given the full name \"Ms. Sarah J Henderson, III\")."
    },
    "familyName": {
      "type": "string",
      "example": "Henderson",
      "description": "The family name of the user, or last name in most Western languages (e.g., \"Henderson\" given the full name \"Ms. Sarah J Henderson, III\")."
    },
    "middleName": {
      "type": "string",
      "example": "Jane",
      "description": "The middle name(s) of the user (e.g., \"Jane\" given the full name \"Ms. Sarah J Henderson, III\")."
    },
    "honorificPrefix": {
      "type": "string",
      "example": "Mr.",
      "description": "The honorific prefix(es) of the user, or title in most Western languages (e.g., \"Ms.\" given the full name \"Ms. Sarah J Henderson, III\")."
    },
    "honorificSuffix": {
      "type": "string",
      "example": "III",
      "description": "The honorific suffix(es) of the user, or suffix in most Western languages (e.g., \"III\" given the full name \"Ms. Sarah J Henderson, III\")."
    }
  }
}