Webex · Schema

SearchUserResponse

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
schemas array Input JSON schemas.
totalResults number Total number of users in search results.
itemsPerPage number The total number of items in a paged result.
startIndex number Start at the one-based offset in the list of matching users.
Resources array A list of users with details.
View JSON Schema on GitHub

JSON Schema

webex-searchuserresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SearchUserResponse",
  "title": "SearchUserResponse",
  "type": "object",
  "required": [
    "schemas"
  ],
  "properties": {
    "schemas": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "urn:ietf:params:scim:api:messages:2.0:ListResponse"
      },
      "description": "Input JSON schemas."
    },
    "totalResults": {
      "type": "number",
      "example": 2,
      "description": "Total number of users in search results."
    },
    "itemsPerPage": {
      "type": "number",
      "example": 2,
      "description": "The total number of items in a paged result."
    },
    "startIndex": {
      "type": "number",
      "example": 1,
      "description": "Start at the one-based offset in the list of matching users."
    },
    "Resources": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SearchGetUserResponse"
      },
      "description": "A list of users with details."
    }
  }
}