{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/Person",
"title": "Person",
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"description": "A unique identifier for the person."
},
"emails": {
"type": "array",
"items": {
"type": "string",
"example": "[email protected]"
},
"description": "The email addresses of the person."
},
"phoneNumbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"work",
"work_extension",
"mobile",
"fax"
],
"description": "The type of phone number.\n * `work` - Work phone number of the person.\n * `work_extension` - Work extension of the person. For the Webex Calling person, the value will have a routing prefix along with the extension.\n * `mobile` - Mobile number of the person.\n * `fax` - FAX number of the person.\n"
},
"value": {
"type": "string",
"example": "+1 408 526 7209",
"description": "The phone number."
},
"primary": {
"type": "boolean",
"example": true,
"description": "Primary number for the person."
}
}
},
"description": "Phone numbers for the person."
},
"extension": {
"type": "string",
"example": "133",
"description": "The Webex Calling extension for the person. Only applies to a person with a Webex Calling license."
},
"locationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzYzNzE1",
"description": "The ID of the location for this person retrieved from BroadCloud."
},
"displayName": {
"type": "string",
"example": "John Andersen",
"description": "The full name of the person."
},
"nickName": {
"type": "string",
"example": "John",
"description": "The nickname of the person if configured. If no nickname is configured for the person, this field will not be present."
},
"firstName": {
"type": "string",
"example": "John",
"description": "The first name of the person."
},
"lastName": {
"type": "string",
"example": "Andersen",
"description": "The last name of the person."
},
"avatar": {
"type": "string",
"example": "https://1efa7a94ed21783e352-c62266528714497a17239ececf39e9e2.ssl.cf1.rackcdn.com/V1~54c844c89e678e5a7b16a306bc2897b9~wx29yGtlTpilEFlYzqPKag==~1600",
"description": "The URL to the person's avatar in PNG format."
},
"orgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"description": "The ID of the organization to which this person belongs."
},
"roles": {
"type": "array",
"items": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh,Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
},
"description": "An array of role strings representing the roles to which this admin user belongs."
},
"licenses": {
"type": "array",
"items": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh,Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
},
"description": "An array of license strings allocated to this person."
},
"department": {
"type": "string",
"example": "Sales",
"description": "The business department the user belongs to."
},
"manager": {
"type": "string",
"example": "John Duarte",
"description": "A manager identifier."
},
"managerId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80ZGEzYTI0OC05YjBhLTQxMDgtODU0NC1iNTQwMzEyZTU2M2E",
"description": "Person ID of the manager."
},
"title": {
"type": "string",
"example": "GM",
"description": "The person's title."
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "work",
"description": "The type of address."
},
"country": {
"type": "string",
"example": "US",
"description": "The user's country."
},
"locality": {
"type": "string",
"example": "Milpitas",
"description": "The user's locality, often city."
},
"region": {
"type": "string",
"example": "California",
"description": "The user's region, often state."
},
"streetAddress": {
"type": "string",
"example": "1099 Bird Ave.",
"description": "The user's street."
},
"postalCode": {
"type": "string",
"example": "99212",
"description": "The user's postal or zip code."
}
}
},
"description": "A person's addresses."
},
"created": {
"type": "string",
"example": "2015-10-18T14:26:16.000Z",
"description": "The date and time the person was created."
},
"lastModified": {
"type": "string",
"example": "2015-10-18T14:26:16.000Z",
"description": "The date and time the person was last changed."
},
"timezone": {
"type": "string",
"example": "America/Denver",
"description": "The time zone of the person if configured. If no timezone is configured on the account, this field will not be present."
},
"lastActivity": {
"type": "string",
"example": "2015-10-18T14:26:16.028Z",
"description": "The date and time of the person's last activity within Webex. This will only be returned for people within your organization or an organization you manage. Presence information will not be shown if the authenticated user has [disabled status sharing](https://help.webex.com/nkzs6wl/)."
},
"siteUrls": {
"type": "array",
"items": {
"type": "string",
"example": "mysite.webex.com#attendee"
},
"description": "One or several site names where this user has a role (host or attendee)."
},
"sipAddresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"personal-room",
"enterprise",
"cloud-calling"
],
"description": "The type of SIP address.\n * `personal-room` - Personal room address.\n * `enterprise` - Enterprise address.\n * `cloud-calling` - Cloud calling address.\n"
},
"value": {
"type": "string",
"example": "[email protected]",
"description": "The SIP address."
},
"primary": {
"type": "boolean",
"description": "Primary SIP address of the person."
}
}
},
"description": "The user's SIP addresses. Read-only."
},
"xmppFederationJid": {
"type": "string",
"example": "[email protected]",
"description": "Identifier for intra-domain federation with other XMPP based messenger systems."
},
"status": {
"type": "string",
"enum": [
"active",
"call",
"DoNotDisturb",
"inactive",
"meeting",
"OutOfOffice",
"pending",
"presenting",
"unknown"
],
"description": "The current presence status of the person. This will only be returned for people within your organization or an organization you manage. Presence information will not be shown if the authenticated user has [disabled status sharing](https://help.webex.com/nkzs6wl/). Presence status is different from Control Hub's \"Last Service Access Time\" which indicates the last time an oAuth token was issued for this user.\n * `active` - Active within the last 10 minutes.\n * `call` - The user is in a call.\n * `DoNotDisturb` - The user has manually set their status to \"Do Not Disturb\".\n * `inactive` - Last activity occurred more than 10 minutes ago.\n * `meeting` - The user is in a meeting.\n * `OutOfOffice` - The user or a Hybrid Calendar service has indicated that they are \"Out of Office\".\n * `pending` - The user has never logged in; a status cannot be determined.\n * `presenting` - The user is sharing content.\n * `unknown` - The user\u2019s status could not be determined.\n"
},
"invitePending": {
"type": "string",
"enum": [
"true",
"false"
],
"description": "Whether or not an invite is pending for the user to complete account activation. This property is only returned if the authenticated user is an admin user for the person's organization.\n * `true` - The person has been invited to Webex but has not created an account.\n * `false` - An invite is not pending for this person.\n"
},
"loginEnabled": {
"type": "string",
"enum": [
"true",
"false"
],
"description": "Whether or not the user is allowed to use Webex. This property is only returned if the authenticated user is an admin user for the person's organization.\n * `true` - The person _can_ log into Webex.\n * `false` - The person _cannot_ log into Webex.\n"
},
"type": {
"type": "string",
"enum": [
"person",
"bot",
"appuser"
],
"description": "The type of person account, such as person or bot.\n * `person` - Account belongs to a person.\n * `bot` - Account is a bot user.\n * `appuser` - Account is a [guest user](/docs/guest-issuer).\n"
}
}
}