Webex · Schema

ArchiveUser

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
schemas array An array of schema URNs that define the structure of the SCIM resource.
userName string 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 array A list of the user's email addresses.
name object
organization string The unique identifier for the organization.
id string The unique identifier for the user.
displayName string The display name of the user in Webex.
meta object
View JSON Schema on GitHub

JSON Schema

webex-archiveuser-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ArchiveUser",
  "title": "ArchiveUser",
  "type": "object",
  "required": [
    "schemas",
    "id",
    "userName",
    "emails",
    "meta"
  ],
  "properties": {
    "schemas": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "urn:scim:schemas:core:1.0,urn:scim:schemas:extension:cisco:commonidentity:1.0"
      },
      "description": "An array of schema URNs that define the structure of the SCIM resource."
    },
    "userName": {
      "type": "string",
      "example": "[email protected]",
      "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": "#/components/schemas/EmailObject"
      },
      "description": "A list of the user's email addresses."
    },
    "name": {
      "$ref": "#/components/schemas/NameObject"
    },
    "organization": {
      "type": "string",
      "example": "410139c6-3bff-4404-9782-09a456ba2cae",
      "description": "The unique identifier for the organization."
    },
    "id": {
      "type": "string",
      "example": "b96936c9-5b86-4a01-8969-e945c91b62f6",
      "description": "The unique identifier for the user."
    },
    "displayName": {
      "type": "string",
      "example": "Mike Tang",
      "description": "The display name of the user in Webex."
    },
    "meta": {
      "$ref": "#/components/schemas/MetaObject"
    }
  }
}