ArchiveUserQueryResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/webex/main/json-schema/webex-archive-user-query-response-schema.json",
  "title": "ArchiveUserQueryResponse",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/webex-archive-users-api-openapi.yml#/components/schemas/ArchiveUserQueryResponse",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "integer",
      "description": "Total number of archived user that match the query."
    },
    "schemas": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of schema URNs that define the structure of the SCIM resource."
    },
    "Resources": {
      "type": "array",
      "description": "A list of archived users matching the filter.",
      "items": {
        "$ref": "#/$defs/ArchiveUser"
      }
    }
  },
  "$defs": {
    "ArchiveUser": {
      "type": "object",
      "required": [
        "schemas",
        "id",
        "userName",
        "emails",
        "name",
        "organization",
        "meta"
      ],
      "properties": {
        "userName": {
          "type": "string",
          "description": "The unique identifier for the user. This must be set to the user's primary email address. The `userName` value must be unique across Webex and is used for authentication."
        },
        "emails": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/EmailObject"
          },
          "description": "A list of the user's email addresses."
        },
        "name": {
          "$ref": "#/$defs/NameObject"
        },
        "organization": {
          "type": "string",
          "description": "The unique identifier for the organization."
        },
        "id": {
          "type": "string",
          "description": "The unique identifier for the user."
        },
        "displayName": {
          "type": "string",
          "description": "The display name of the user in Webex."
        },
        "meta": {
          "$ref": "#/$defs/MetaObject"
        }
      }
    },
    "EmailObject": {
      "type": "object",
      "properties": {
        "value": {
          "type": "string",
          "description": "The email address."
        },
        "type": {
          "type": "string",
          "enum": [
            "work",
            "home",
            "room",
            "other"
          ],
          "description": "The type of the email."
        },
        "display": {
          "type": "string",
          "description": "A human-readable description, primarily used for display purposes."
        },
        "primary": {
          "type": "boolean",
          "description": "Email status boolean value. If the type is work and primary is true, the value must equal `userName`."
        }
      }
    },
    "MetaObject": {
      "type": "object",
      "description": "Response metadata.",
      "required": [
        "created",
        "lastModified",
        "version",
        "location"
      ],
      "properties": {
        "resourceType": {
          "type": "string"
        },
        "organizationID": {
          "type": "string"
        },
        "created": {
          "type": "string",
          "description": "The date and time the group was created."
        },
        "lastModified": {
          "type": "string",
          "description": "The date and time the group was last changed."
        },
        "version": {
          "type": "string",
          "description": "The version of the user."
        },
        "location": {
          "type": "string",
          "description": "The resource itself."
        }
      }
    },
    "NameObject": {
      "type": "object",
      "description": "The components of the user's real name.",
      "properties": {
        "givenName": {
          "type": "string",
          "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",
          "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",
          "description": "The middle name(s) of the user (e.g., \"Jane\" given the full name \"Ms. Sarah J Henderson, III\")."
        },
        "honorificPrefix": {
          "type": "string",
          "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",
          "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\")."
        }
      }
    }
  }
}