Webex · Schema

SearchGetUserResponse

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
schemas array Input JSON schemas.
id string Webex Identity assigned user identifier.
userName string A unique identifier for the user and authenticates the user in Webex. This must be set to the user's primary email address. No other user in Webex may have the same `userName` value and thus is requir
active boolean A boolean value of "true" or "false" indicating whether the user is allowed to login in Webex.
roles array List of roles assigned to the user.
name object The components of the user's real name.
displayName string The name displayed for the user in Webex.
nickName string A casual name of the user. For example, Bob when the user's formal name is Robert.
emails array A list of the user's email addresses, including primary and alternative emails. The primary work email address must match the value of the user's username.
userType object User type.
profileUrl string A fully qualified URL pointing to a page representing the user's online profile.
title string The user's business title. Examples of a title is "Business Manager". "Senior Accountant", "Engineer" etc.
preferredLanguage string User's preferred language. Acceptable values are based on the [ISO-696](http://www.loc.gov/standards/iso639-2/php/code_list.php) and [ISO-3166](https://www.iso.org/obp/ui/#search) with the 2 letter la
locale string The user's locale which represents the user's currency, time format, and numerical representations. Acceptable values are based on the [ISO-696](http://www.loc.gov/standards/iso639-2/php/code_list.php
externalId string User identifier provided by an external provisioning source.
timezone string The user's time zone specified in the [IANA timezone](https://nodatime.org/timezones) timezone format, for example, "America/Los_Angeles".
phoneNumbers array A list of user's phone numbers.
groups array A list of group details returned only when `includeGroupDetails` or `returnGroups` request parameters are set to true.
photos array A list of photo objects for the user.
addresses array User's physical mailing address.
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User object SCIM2 enterprise extension
urn:scim:schemas:extension:cisco:webexidentity:2.0:User object The Cisco extension of SCIM 2.
meta object Response metadata.
View JSON Schema on GitHub

JSON Schema

webex-searchgetuserresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SearchGetUserResponse",
  "title": "SearchGetUserResponse",
  "type": "object",
  "required": [
    "schemas",
    "id",
    "userName",
    "userType",
    "meta"
  ],
  "properties": {
    "schemas": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "urn:ietf:params:scim:schemas:core:2.0:User,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,urn:scim:schemas:extension:cisco:webexidentity:2.0:User"
      },
      "description": "Input JSON schemas."
    },
    "id": {
      "type": "string",
      "example": "3426a8e3-d414-4bf0-a493-4f6787632a13",
      "description": "Webex Identity assigned user identifier."
    },
    "userName": {
      "type": "string",
      "example": "[email protected]",
      "description": "A unique identifier for the user and authenticates the user in Webex.  This must be set to the user's primary email address.  No other user in Webex may have the same `userName` value and thus is required to be unique within Webex."
    },
    "active": {
      "type": "boolean",
      "example": true,
      "description": "A boolean value of \"true\" or \"false\" indicating whether the user is allowed to login in Webex."
    },
    "roles": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/RoleObject"
      },
      "description": "List of roles assigned to the user."
    },
    "name": {
      "$ref": "#/components/schemas/NameObject",
      "description": "The components of the user's real name."
    },
    "displayName": {
      "type": "string",
      "example": "Mr. Jonathan Jane Joestar, III",
      "description": "The name displayed for the user in Webex."
    },
    "nickName": {
      "type": "string",
      "example": "JoJo",
      "description": "A casual name of the user. For example, Bob when the user's formal name is Robert."
    },
    "emails": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EmailObject"
      },
      "description": "A list of the user's email addresses, including primary and alternative emails. The primary work email address must match the value of the user's username."
    },
    "userType": {
      "$ref": "#/components/schemas/UserTypeObject",
      "description": "User type."
    },
    "profileUrl": {
      "type": "string",
      "example": "https://jojowiki.com/Jonathan_Joestar",
      "description": "A fully qualified URL pointing to a page representing the user's online profile."
    },
    "title": {
      "type": "string",
      "example": "Sales manager",
      "description": "The user's business title.  Examples of a title is \"Business Manager\". \"Senior Accountant\", \"Engineer\" etc."
    },
    "preferredLanguage": {
      "type": "string",
      "example": "en_US",
      "description": "User's preferred language. Acceptable values are based on the [ISO-696](http://www.loc.gov/standards/iso639-2/php/code_list.php) and [ISO-3166](https://www.iso.org/obp/ui/#search) with the 2 letter language code followed by an _ and then the 2 letter country code.  Examples are:\n\n                                    en_US : for United States English or fr_FR for Parisian French."
    },
    "locale": {
      "type": "string",
      "example": "en_US",
      "description": "The user's locale which represents the user's currency, time format, and numerical representations.  Acceptable values are based on the [ISO-696](http://www.loc.gov/standards/iso639-2/php/code_list.php) and [ISO-3166](https://www.iso.org/obp/ui/#search) with the 2 letter language code followed by an _ and then the 2 letter country code.  Examples are:\n\n                         en_US : for United States English or fr_FR for Parisian French."
    },
    "externalId": {
      "type": "string",
      "example": "externalIdValue",
      "description": "User identifier provided by an external provisioning source."
    },
    "timezone": {
      "type": "string",
      "example": "America/Los_Angeles",
      "description": "The user's time zone specified in the [IANA timezone](https://nodatime.org/timezones) timezone format, for example, \"America/Los_Angeles\"."
    },
    "phoneNumbers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PhoneNumberObject"
      },
      "description": "A list of user's phone numbers."
    },
    "groups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/GroupObject"
      },
      "description": "A list of group details returned only when `includeGroupDetails` or `returnGroups` request parameters are set to true."
    },
    "photos": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PhotoObject"
      },
      "description": "A list of photo objects for the user."
    },
    "addresses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AddressObject"
      },
      "description": "User's physical mailing address."
    },
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
      "type": "object",
      "properties": {
        "costCenter": {
          "type": "string",
          "example": "costCenter 123",
          "description": "Name of a cost center."
        },
        "organization": {
          "type": "string",
          "example": "Cisco webexidentity",
          "description": "Name of an organization."
        },
        "division": {
          "type": "string",
          "example": "division 456",
          "description": "Name of a division."
        },
        "department": {
          "type": "string",
          "example": "department 789",
          "description": "Name of a department."
        },
        "employeeNumber": {
          "type": "string",
          "example": "518-8888-888",
          "description": "Numeric or alphanumeric identifier assigned to a person, typically based on the order of hire or association with an organization."
        },
        "manager": {
          "$ref": "#/components/schemas/ManagerResponseObject",
          "description": "The user's manager."
        }
      },
      "description": "SCIM2 enterprise extension"
    },
    "urn:scim:schemas:extension:cisco:webexidentity:2.0:User": {
      "type": "object",
      "required": [
        "accountStatus"
      ],
      "properties": {
        "accountStatus": {
          "$ref": "#/components/schemas/AccountStatusObject",
          "description": "An array of additional information about a user's status."
        },
        "sipAddresses": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/SipAddressObject"
          },
          "description": "`sipAddress` values for the user."
        },
        "managedOrgs": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/ManagedOrgsObject"
          },
          "description": "Organizations that the user can manage."
        },
        "managedGroups": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/ManagedGroupsObject"
          },
          "description": "Groups that the user can manage."
        },
        "extensionAttribute*": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The extension attributes of the user. Postfix support from 1 to 15, for example: \"extensionAttribute1\", \"extensionAttribute2\", ..., \"extensionAttribute15\"."
        },
        "externalAttribute*": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/ExternalAttributeObject"
          },
          "description": "The external attributes of the user. Postfix support from 1 to 15, for example: \"externalAttribute1\", \"externalAttribute2\", ..., \"externalAttribute15\"."
        }
      },
      "description": "The Cisco extension of SCIM 2."
    },
    "meta": {
      "$ref": "#/components/schemas/MetaObject",
      "description": "Response metadata."
    }
  }
}