Webex · Schema

GroupMemberResponse

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
schemas array Input JSON schemas.
displayName string A human-readable name for the group.
totalResults number Total number of groups 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 groups.
members array A list of members of this group.
View JSON Schema on GitHub

JSON Schema

webex-groupmemberresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GroupMemberResponse",
  "title": "GroupMemberResponse",
  "type": "object",
  "required": [
    "schemas",
    "displayName"
  ],
  "properties": {
    "schemas": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "urn:ietf:params:scim:api:messages:2.0:ListResponse"
      },
      "description": "Input JSON schemas."
    },
    "displayName": {
      "type": "string",
      "example": "[email protected]",
      "description": "A human-readable name for the group."
    },
    "totalResults": {
      "type": "number",
      "example": 2,
      "description": "Total number of groups 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 groups."
    },
    "members": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "example": "user",
            "description": "A label indicating the type of resource, for example user, machine, or group."
          },
          "value": {
            "type": "string",
            "example": "c5349664-9f3d-410b-8bd3-6c31f181f13d",
            "description": "The identifier of the member of this Group."
          },
          "display": {
            "type": "string",
            "example": "A user",
            "description": "A human-readable name for the group member."
          }
        }
      },
      "description": "A list of members of this group."
    }
  }
}