openapi: 3.2.0
info:
  title: Webex SCIM 2 Schemas API
  version: 1.0.0
  description: 'Operations tagged SCIM 2 Schemas across 2 of this provider''s published API definitions: webex-admin-openapi.json,
    webex-scim-2-schemas-api-openapi.yml. Each path carries the servers of the definition it was published in.'
  x-provenance:
    method: harvested
    authored_by: Cisco Webex
    harvested_by: API Evangelist
    harvested_on: '2026-08-19'
    first_party: true
    note: Published by Cisco. Retrieved unmodified except for this x-provenance block.
    provider_published: true
    derived_view: Per-tag view of webex-admin-openapi.json, the provider's source document. Operations and schemas are the
      provider's, unmodified; only the partition is ours.
    derived_from: webex-admin-openapi.json
    operation_coverage: 3/3
  x-evidence:
  - type: source
    url: https://github.com/webex/webex-openapi-specs/blob/main/public-spec/webex-admin.json
  - type: raw
    url: https://raw.githubusercontent.com/webex/webex-openapi-specs/main/public-spec/webex-admin.json
tags:
- name: SCIM 2 Schemas
paths:
  /Schemas/SCIM2/Group:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGroupSchemaResponse'
              example:
                urn:ietf:params:scim:schemas:core:2.0:Group:
                  id: urn:ietf:params:scim:schemas:core:2.0:Group
                  name: Group
                  description: Group
                  attributes:
                  - name: id
                    type: String
                    multiValued: false
                    description: A unique identifier of this `Group` resource defined by the service provider.
                    required: false
                    caseExact: true
                    mutability: ReadOnly
                    returned: Default
                    uniqueness: Global
                  - name: displayName
                    type: String
                    multiValued: false
                    description: A human-readable name for the `Group`. REQUIRED.
                    required: false
                    caseExact: false
                    mutability: ReadWrite
                    returned: Default
                    uniqueness: None
                    length: 512
                  - name: externalId
                    type: String
                    multiValued: false
                    description: An identifier for the resource as defined by the provision client.
                    required: false
                    caseExact: false
                    mutability: ReadWrite
                    returned: Default
                    uniqueness: None
                    length: 256
                  - name: members
                    type: String
                    multiValued: true
                    description: A list of roles for the user that collectively represent who the user is.
                    required: false
                    caseExact: false
                    mutability: ReadWrite
                    returned: Default
                    uniqueness: None
                    subAttributes:
                    - name: value
                      type: Reference
                      referenceTypes:
                      - external
                      multiValued: false
                      description: The identifier of the member of this `Group`.
                      required: false
                      caseExact: false
                      mutability: Immutable
                      returned: Default
                      uniqueness: None
                    - name: type
                      type: String
                      multiValued: false
                      description: A label indicating the type of resource, e.g., 'Group', 'Machine', or 'Group'.
                      required: false
                      caseExact: false
                      mutability: Immutable
                      returned: Default
                      canonicalValues:
                      - Group
                      - User
                      - Machine
                      uniqueness: None
                    - name: display
                      type: String
                      multiValued: false
                      description: A human-readable name, primarily used for display purposes.
                      required: false
                      caseExact: false
                      mutability: ReadOnly
                      returned: Default
                      uniqueness: None
                    - name: $ref
                      type: Reference
                      referenceTypes:
                      - User
                      - Group
                      - Machine
                      multiValued: false
                      description: The URI corresponding to a SCIM resource that is a member of this `Group`.
                      required: false
                      caseExact: false
                      mutability: Immutable
                      returned: Default
                      uniqueness: None
                    size: 500
                urn:scim:schemas:extension:cisco:webexidentity:2.0:Group:
                  id: urn:scim:schemas:extension:cisco:webexidentity:2.0:Group
                  name: Cisco Group
                  description: Cisco Group
                  attributes:
                  - name: usage
                    type: String
                    multiValued: false
                    description: The identifier of this `Group`.
                    required: false
                    caseExact: false
                    mutability: ReadWrite
                    returned: Default
                    canonicalValues:
                    - location
                    - distribution
                    - policy
                    uniqueness: None
                  - name: provisionSource
                    type: String
                    multiValued: false
                    description: The type of the account provision source.
                    required: false
                    caseExact: false
                    mutability: ReadOnly
                    returned: Default
                    canonicalValues:
                    - SCIM
                    - AD
                    - AAD
                    - BROADWORKS
                    - OKTA
                    uniqueness: None
                  - name: owners
                    type: String
                    multiValued: true
                    description: The owners of this group.
                    required: false
                    caseExact: false
                    mutability: ReadWrite
                    returned: Default
                    uniqueness: None
                    subAttributes:
                    - name: value
                      type: String
                      multiValued: false
                      description: The value of owners.
                      required: false
                      caseExact: false
                      mutability: ReadWrite
                      returned: Default
                      uniqueness: None
                    - name: display
                      type: String
                      multiValued: false
                      description: A human-readable name, primarily used for display purposes.
                      required: false
                      caseExact: false
                      mutability: ReadWrite
                      returned: Default
                      uniqueness: None
                    - name: primary
                      type: Boolean
                      multiValued: false
                      description: A Boolean value indicating the 'primary' or preferred attribute value for this attribute.
                        The primary attribute value 'true' must appear no more than once.
                      required: false
                      caseExact: false
                      mutability: ReadWrite
                      returned: Default
                      uniqueness: None
                    size: 30
                  - name: managedBy
                    type: String
                    multiValued: true
                    description: The resources that have delegated roles on this `Group`.
                    required: false
                    caseExact: false
                    mutability: ReadWrite
                    returned: Default
                    uniqueness: None
                    subAttributes:
                    - name: orgId
                      type: String
                      multiValued: false
                      description: The organization identifier of the resource.
                      required: false
                      caseExact: false
                      mutability: Immutable
                      returned: Default
                      uniqueness: None
                      length: 64
                    - name: type
                      type: String
                      multiValued: false
                      description: The resource type.
                      required: false
                      caseExact: false
                      mutability: Immutable
                      returned: Default
                      canonicalValues:
                      - Group
                      - User
                      - Machine
                      uniqueness: None
                    - name: id
                      type: String
                      multiValued: false
                      description: The identifier of the resource.
                      required: false
                      caseExact: false
                      mutability: Immutable
                      returned: Default
                      uniqueness: None
                    - name: role
                      type: String
                      multiValued: false
                      description: The delegated role.
                      required: false
                      caseExact: false
                      mutability: ReadWrite
                      returned: Default
                      uniqueness: None
                      length: 64
                    size: 30
                  - name: inheritances
                    type: String
                    multiValued: true
                    description: Inheritance supported by this group.
                    required: false
                    caseExact: false
                    mutability: ReadWrite
                    returned: Default
                    uniqueness: None
                    subAttributes:
                    - name: type
                      type: String
                      multiValued: false
                      description: The resource type.
                      required: false
                      caseExact: false
                      mutability: Immutable
                      returned: Default
                      canonicalValues:
                      - role
                      uniqueness: None
                    - name: value
                      type: String
                      multiValued: false
                      description: The value.
                      required: false
                      caseExact: false
                      mutability: Immutable
                      returned: Default
                      canonicalValues:
                      - id_user_admin
                      - id_readonly_admin
                      - id_device_admin
                      - id_full_admin
                      uniqueness: None
                    - name: nested
                      type: String
                      multiValued: false
                      description: The boolean value if field is nested.
                      required: false
                      caseExact: false
                      mutability: Immutable
                      returned: Default
                      uniqueness: None
                    - name: scope
                      type: String
                      multiValued: false
                      description: The scope.
                      required: false
                      caseExact: false
                      mutability: Immutable
                      returned: Default
                      uniqueness: None
                    size: 10
                  - name: memberFilter
                    type: String
                    multiValued: true
                    description: The memberFilter for the `Group`.
                    required: false
                    caseExact: false
                    mutability: ReadWrite
                    returned: Default
                    uniqueness: None
                    subAttributes:
                    - name: value
                      type: String
                      multiValued: false
                      description: The value of memberFilter.
                      required: false
                      caseExact: false
                      mutability: ReadWrite
                      returned: Default
                      uniqueness: None
                    - name: display
                      type: String
                      multiValued: false
                      description: A human-readable name, primarily used for display purposes.
                      required: false
                      caseExact: false
                      mutability: ReadWrite
                      returned: Default
                      uniqueness: None
                    - name: type
                      type: String
                      multiValued: false
                      description: A label indicating the attribute's function.
                      required: false
                      caseExact: false
                      mutability: ReadWrite
                      returned: Default
                      canonicalValues:
                      - user
                      uniqueness: None
                    - name: primary
                      type: Boolean
                      multiValued: false
                      description: A Boolean value indicating the 'primary' or preferred attribute value for this attribute.
                        The primary attribute value 'true' must appear no more than once.
                      required: false
                      caseExact: false
                      mutability: ReadWrite
                      returned: Default
                      uniqueness: None
                    size: 1
                  - name: groupType
                    type: String
                    multiValued: false
                    description: The type of the `Group`.
                    required: false
                    caseExact: false
                    mutability: ReadWrite
                    returned: Default
                    canonicalValues:
                    - unique_flat_static
                    - dynamic
                    - flat_static
                    - nested_static
                    uniqueness: None
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message
            will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist.
            Also returned when the requested format is not supported by the requested method.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The request could not be processed because it conflicts with some established rule of the
            system. For example, a person may not be added to a room more than once.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used
            a media type that is not supported.'
        '423':
          description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that
            specifies how many seconds you need to wait before attempting the request again.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has
            been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before
            a successful request can be made.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact
            the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the
            request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please
            try to reduce it.'
      summary: Get Group Schema
      operationId: Get Group Schema
      description: 'This API allows the service client to get all the `Group` schemas information from CI.


        **Authorization:**


        OAuth token rendered by Identity Broker.


        One of the following OAuth scopes is required:


        - `identity:people_rw`


        - `identity:organizations_rw`


        The following administrators can use this API:


        - `id_full_admin`


        - `id_user_admin`


        - `id_readonly_admin`


        - `id_device_admin`'
      tags:
      - SCIM 2 Schemas
      parameters: []
  /Schemas/SCIM2/User:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUserSchemaResponse'
              example:
                urn:scim:schemas:extension:cisco:webexidentity:2.0:User:
                  id: urn:scim:schemas:extension:cisco:webexidentity:2.0:User
                  name: EnterpriseUser
                  description: Enterprise User
                  attributes:
                  - name: accountStatus
                    type: String
                    multiValued: true
                    description: Account status of the user.
                    required: false
                    caseExact: false
                    mutability: ReadWrite
                    returned: Default
                    canonicalValues:
                    - compliance-transient
                    - pending-transient
                    - marked_deleted
                    - transient
                    - fraud-transient
                    - fraud
                    - pending
                    - active
                    - disabled
                    - suspended
                    uniqueness: None
                  - name: authProvider
                    type: String
                    multiValued: false
                    description: Authentication provider for the user. Base on organization configuration
                    required: false
                    caseExact: false
                    mutability: ReadWrite
                    returned: Default
                    canonicalValues:
                    - facebook
                    - O365
                    - google
                    - cco
                    uniqueness: None
                  - name: teamsClusterId
                    type: String
                    multiValued: false
                    description: teamsClusterId of the organization user belongs to.
                    required: false
                    caseExact: false
                    mutability: ReadOnly
                    returned: Default
                    uniqueness: None
                  - name: isTeamsOnJabberEnabled
                    type: Boolean
                    multiValued: false
                    description: Whether user is enabled teams in Jabber.
                    required: false
                    caseExact: false
                    mutability: ReadWrite
                    returned: Default
                    uniqueness: None
                  - name: isUCCallOnJabberEnabled
                    type: Boolean
                    multiValued: false
                    description: Whether user is enabled On UC Call in Jabber.
                    required: false
                    caseExact: false
                    mutability: ReadWrite
                    returned: Default
                    uniqueness: None
                  - name: mfaEnabled
                    type: Boolean
                    multiValued: false
                    description: Whether user is enabled for MFA.
                    required: false
                    caseExact: false
                    mutability: ReadWrite
                    returned: Default
                    uniqueness: None
                  - name: macAddresses
                    type: String
                    multiValued: true
                    description: macAddresses assigned to this user.
                    required: false
                    caseExact: false
                    mutability: ReadWrite
                    returned: Default
                    uniqueness: None
                    size: 50
                  - name: licenseID
                    type: String
                    multiValued: true
                    description: licenseIDs assigned to this user. Webex Identity does not interpret the format or semantics
                      of the value.
                    required: false
                    caseExact: false
                    mutability: ReadWrite
                    returned: Default
                    uniqueness: None
                    size: 1000
                  - name: userSettings
                    type: String
                    multiValued: true
                    description: Settings value for the user. Webex Identity does not interpret the format or semantics of
                      the value.
                    required: false
                    caseExact: false
                    mutability: ReadWrite
                    returned: Default
                    uniqueness: None
                    size: 1000
                  - name: userPreferences
                    type: String
                    multiValued: true
                    description: User preference. Webex Identity does not interpret the format or semantics of the value.
                    required: false
                    caseExact: false
                    mutability: ReadWrite
                    returned: Default
                    uniqueness: None
                    size: 1000
                  - name: sipAddresses
                    type: Complex
                    multiValued: true
                    description: SipAddress values for the User.
                    required: false
                    caseExact: false
                    mutability: ReadWrite
                    returned: Default
                    uniqueness: None
                    subAttributes:
                    - name: value
                      type: String
                      multiValued: false
                      description: The value of sipAddresses.
                      required: false
                      caseExact: false
                      mutability: ReadWrite
                      returned: Default
                      uniqueness: None
                    - name: display
                      type: String
                      multiValued: false
                      description: A human-readable name, primarily used for display purposes.
                      required: false
                      caseExact: false
                      mutability: ReadWrite
                      returned: Default
                      uniqueness: None
                    - name: type
                      type: String
                      multiValued: false
                      description: A label indicating the attribute's function.
                      required: false
                      caseExact: false
                      mutability: ReadWrite
                      returned: Default
                      canonicalValues:
                      - enterprise
                      - cloud-calling
                      - personal-room
                      uniqueness: None
                    - name: primary
                      type: Boolean
                      multiValued: false
                      description: A Boolean value indicating the 'primary' or preferred attribute value for this attribute.
                        The primary attribute value 'true' MUST appear no more than once.
                      required: false
                      caseExact: false
                      mutability: ReadWrite
                      returned: Default
                      uniqueness: None
                    size: 2000
                  - name: trainSiteNames
                    type: String
                    multiValued: true
                    description: List of CI-enabled sites the user belongs to.
                    required: false
                    caseExact: false
                    mutability: ReadWrite
                    returned: Default
                    uniqueness: None
                    size: 2000
                  - name: managedSites
                    type: Complex
                    multiValued: true
                    description: Used to identify that the user is site admin of a site.
                    required: false
                    caseExact: false
                    mutability: ReadWrite
                    returned: Default
                    uniqueness: None
                    subAttributes:
                    - name: siteName
                      type: String
                      multiValued: false
                      description: Site name
                      required: true
                      caseExact: true
                      mutability: ReadWrite
                      returned: Default
                      uniqueness: None
                      length: 512
                    - name: role
                      type: String
                      multiValued: false
                      description: Role in the site for the user.
                      required: true
                      caseExact: false
                      mutability: ReadWrite
                      returned: Default
                      uniqueness: None
                      length: 64
                    size: 2000
                  - name: linkedTrainSiteNames
                    type: String
                    multiValued: true
                    description: List of none CI-enabled WebEx sites that the user is linked to through account linking process.
                    required: false
                    caseExact: false
                    mutability: ReadWrite
                    returned: Default
                    uniqueness: None
                    size: 2000
                  - name: primaryLinkedTrainSiteName
                    type: String
                    multiValued: false
                    description: If set, Webex Identity will send user to the train site to login. Value is the name of the
                      train site.
                    required: false
                    caseExact: false
                    mutability: ReadWrite
                    returned: Default
                    uniqueness: None
                    length: 128
                  - name: toBeConverted
                    type: String
                    multiValued: false
                    description: To be converted value.
                    required: false
                    caseExact: false
                    mutability: ReadOnly
                    returned: Default
                    uniqueness: None
                    length: 254
                  - name: managedOrgs
                    type: Complex
                    multiValued: true
                    description: Organizations that the user can manage.
                    required: false
                    caseExact: false
                    mutability: ReadWrite
                    returned: Default
                    uniqueness: None
                    subAttributes:
                    - name: orgId
                      type: String
                      multiValued: false
                      description: Identity of the organization
                      required: false
                      caseExact: false
                      mutability: ReadWrite
                      returned: Default
                      uniqueness: None
                      length: 64
                    - name: role
                      type: String
                      multiValued: false
                      description: Role in the target organization for the user.
                      required: false
                      caseExact: false
                      mutability: ReadWrite
                      returned: Default
                      uniqueness: None
                      length: 64
                    size: 2000
                  - name: managedGroups
                    type: Complex
                    multiValued: true
                    description: Organizations that the user can manage.
                    required: false
                    caseExact: false
                    mutability: ReadWrite
                    returned: Default
                    uniqueness: None
                    subAttributes:
                    - name: orgId
                      type: String
                      multiValued: false
                      description: Identity of the organization
                      required: false
                      caseExact: false
                      mutability: ReadWrite
                      returned: Default
                      uniqueness: None
                      length: 64
                    - name: groupId
                      type: String
                      multiValued: false
                      description: Identity of the group
                      required: false
                      caseExact: false
                      mutability: ReadWrite
                      returned: Default
                      uniqueness: None
                      length: 64
                    - name: role
                      type: String
                      multiValued: false
                      description: Role in the target group for the user.
                      required: false
                      caseExact: false
                      mutability: ReadWrite
                      returned: Default
                      uniqueness: None
                      length: 64
                    size: 2000
                  - name: extLinkedAccts
                    type: Complex
                    multiValued: true
                    description: External linked account for the user.
                    required: false
                    caseExact: false
                    mutability: ReadWrite
                    returned: Default
                    uniqueness: None
                    subAttributes:
                    - name: providerID
                      type: String
                      multiValued: false
                      description: Identity for the external linked account provider.
                      required: false
                      caseExact: false
                      mutability: R

# --- truncated at 32 KB (145 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/webex/refs/heads/main/openapi/webex-scim-2-schemas-api-openapi.yml