Webex SCIM 2 Groups API

The SCIM 2 Groups API from Webex — 3 operation(s) for scim 2 groups.

OpenAPI Specification

webex-scim-2-groups-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  title: Webex Admin Address Book SCIM 2 Groups API
  version: 1.0.0
  description: The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings. These APIs enable automation of user provisioning, license assignment, compliance management, and audit event retrieval. Administrators can integrate with enterprise identity systems, enforce security policies, monitor usage, and streamline onboarding/offboarding processes. The APIs support granular control over organizational resources, making them ideal for large-scale deployments and custom admin tooling.
tags:
- name: SCIM 2 Groups
paths:
  /identity/scim/{orgId}/v2/Groups:
    post:
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGroupResponse'
              example:
                schemas:
                - urn:ietf:params:scim:schemas:core:2.0:Group
                - urn:scim:schemas:extension:cisco:webexidentity:2.0:Group
                id: cb8f48e4-5db2-496b-b43d-83d8d5a2a4b3
                displayName: wade_test_ccbeca2c-5f25-4c3a-b03c-e3bbc5368405@webex.identity.com
                externalId: test
                members:
                - value: c5349664-9f3d-410b-8bd3-6c31f181f13d
                  type: user
                  example: https://example.com/v2/Users/c5349664-9f3d-410b-8bd3-6c31f181f13d
                  display: A user
                - value: ffd2164c-b938-46dd-8b2f-def6c33b45d0
                  type: group
                  example: https://example.com/v2/Groups/ffd2164c-b938-46dd-8b2f-def6c33b45d0
                  display: A nested group
                meta:
                  resourceType: group
                  created: '2011-08-01T21:32:44.882Z'
                  lastModified: '2011-08-01T21:32:44.882Z'
                  version: W/"e180ee84f0671b1"
                  location: https://example.com/v2/Groups/e9e30dba-f08f-4109-8486-d5c6a331660a
                urn:scim:schemas:extension:cisco:webexidentity:2.0:Group:
                  usage: location
                  inheritances:
                  - type: role
                    value: id_full_admin
                    nested: false
                    scope:
                    - user
                  owners:
                  - value: bb9e77e5-91c3-4006-87c7-c18d885174c7
                  - value: 93e10e81-f836-434c-8e4c-8f496aeef8d5
                  managedBy:
                  - orgId: e82f0522-09b1-49fb-9fff-735fee313456
                    type: user
                    id: 0f0c3024-73dc-4e1f-b4b0-f47e67c0399c
                    role: location_full_admin
                  - orgId: cd828192-269c-4bc7-943b-273555227961
                    type: machine
                    id: 4ecec95a-0493-4df0-bd1c-c97712561077
                    role: id_user_admin
                  provisionSource: AD
                  meta:
                    organizationID: e9f9ab27-0459-4cd0-bd72-089bde5a7da6
        '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: Create a group
      operationId: Create a group
      description: "Create a new group for a given organization. The group may optionally be created with group members.\n\n<br/>\n\n**Authorization**\n\nOAuth token returned by Identity Broker.\n\n<br/>\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n<br/>\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_group_admin`\n\n<br/>\n\n**Usage**:\n\n1. The input JSON must conform to one of the following schemas:\n    - `urn:ietf:params:scim:schemas:core:2.0:Group`\n    - `urn:scim:schemas:extension:cisco:webexidentity:2.0:Group`\n\n1. Unrecognized schemas (ID/section) are ignored.\n\n1. Read-only attributes provided as input values are ignored."
      tags:
      - SCIM 2 Groups
      parameters:
      - name: orgId
        in: path
        description: The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.
        required: true
        example: e9f9ab27-0459-4cd0-bd72-089bde5a7da6
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
              schemas:
              - urn:ietf:params:scim:schemas:core:2.0:Group
              - urn:scim:schemas:extension:cisco:webexidentity:2.0:Group
              displayName: group1@example.com
              externalId: test
              members:
              - value: c5349664-9f3d-410b-8bd3-6c31f181f13d
                type: user
              urn:scim:schemas:extension:cisco:webexidentity:2.0:Group:
                usage: policy
                inheritances:
                - type: role
                  value: id_full_admin
                  nested: false
                  scope:
                  - user
                owners:
                - value: c5349664-9f3d-410b-8bd3-6c31f181f13d
                managedBy:
                - orgId: d1349664-9f3d-410b-8bd3-6c31f181f14e
                  type: user
                  id: c5349664-9f3d-410b-8bd3-6c31f181f13d
                  role: location_full_admin
            schema:
              $ref: '#/components/schemas/PostGroup'
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchGroupResponse'
              example:
                schemas:
                - urn:ietf:params:scim:api:messages:2.0:ListResponse
                totalResults: 2
                itemsPerPage: 2
                startIndex: 1
                Resources:
                - schemas:
                  - urn:ietf:params:scim:schemas:core:2.0:Group
                  - urn:scim:schemas:extension:cisco:webexidentity:2.0:Group
                  id: 6d26ba8b-8a07-465c-8e1a-c283eea9b4fd
                  displayName: wade_test_ccbeca2c-5f25-4c3a-b03c-e3bbc5368405@webex.identity.com
                  externalId: test
                  members:
                  - value: c5349664-9f3d-410b-8bd3-6c31f181f13d
                    type: user
                    example: https://example.com/v2/Users/c5349664-9f3d-410b-8bd3-6c31f181f13d
                    display: A user
                  - value: ffd2164c-b938-46dd-8b2f-def6c33b45d0
                    type: group
                    example: https://example.com/v2/Groups/ffd2164c-b938-46dd-8b2f-def6c33b45d0
                    display: A nested group
                  meta:
                    resourceType: group
                    created: '2011-08-01T21:32:44.882Z'
                    lastModified: '2011-08-01T21:32:44.882Z'
                    version: W/"e180ee84f0671b1"
                    location: https://example.com/v2/Groups/6d26ba8b-8a07-465c-8e1a-c283eea9b4fd
                  urn:scim:schemas:extension:cisco:webexidentity:2.0:Group:
                    usage: location
                    inheritances:
                    - type: role
                      value: id_full_admin
                      nested: false
                      scope:
                      - user
                    owners:
                    - value: bb9e77e5-91c3-4006-87c7-c18d885174c7
                    - value: 93e10e81-f836-434c-8e4c-8f496aeef8d5
                    managedBy:
                    - orgId: e82f0522-09b1-49fb-9fff-735fee313456
                      type: user
                      id: 0f0c3024-73dc-4e1f-b4b0-f47e67c0399c
                      role: location_full_admin
                    - orgId: cd828192-269c-4bc7-943b-273555227961
                      type: Machine
                      id: 4ecec95a-0493-4df0-bd1c-c97712561077
                      role: id_user_admin
                    provisionSource: AD
                    meta:
                      organizationID: 4859c223-7f76-453a-919d-4138645454546
                - schemas:
                  - urn:ietf:params:scim:schemas:core:2.0:Group
                  - urn:scim:schemas:extension:cisco:webexidentity:2.0:Group
                  id: 89ef7711-0d50-469f-8eb7-8ef47da7102f
                  displayName: wade_test_ccbeca2c-5f25-4c3a-b03c-e3bbc5368405@webex.identity.com
                  externalId: test
                  members:
                  - value: c5349664-9f3d-410b-8bd3-6c31f181f13d
                    type: user
                    example: https://example.com/v2/Users/c5349664-9f3d-410b-8bd3-6c31f181f13d
                    display: A user
                  - value: ffd2164c-b938-46dd-8b2f-def6c33b45d0
                    type: group
                    example: https://example.com/v2/Groups/ffd2164c-b938-46dd-8b2f-def6c33b45d0
                    display: A nested group
                  meta:
                    resourceType: group
                    created: '2011-08-01T21:32:44.882Z'
                    lastModified: '2011-08-01T21:32:44.882Z'
                    version: W/"e180ee84f0671b1"
                    location: https://example.com/v2/Groups/89ef7711-0d50-469f-8eb7-8ef47da7102f
                  urn:scim:schemas:extension:cisco:webexidentity:2.0:Group:
                    usage: location
                    owners:
                    - value: bb9e77e5-91c3-4006-87c7-c18d885174c7
                    - value: 93e10e81-f836-434c-8e4c-8f496aeef8d5
                    managedBy:
                    - orgId: e82f0522-09b1-49fb-9fff-735fee313456
                      type: user
                      id: 0f0c3024-73dc-4e1f-b4b0-f47e67c0399c
                      role: location_full_admin
                    - orgId: cd828192-269c-4bc7-943b-273555227961
                      type: Machine
                      id: 4ecec95a-0493-4df0-bd1c-c97712561077
                      role: id_user_admin
                    provisionSource: AD
                    meta:
                      organizationID: e9f9ab27-0459-4cd0-bd72-089bde5a7da6
        '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: Search groups
      operationId: Search groups
      description: 'Retrieve a list of groups in the organization.


        Long result sets are split into [pages](/docs/basics#pagination).


        <br/>


        **Authorization**


        An OAuth token rendered by Identity Broker.


        <br/>


        One of the following OAuth scopes is required:


        - `identity:people_rw`


        - `identity:people_read`


        <br/>


        The following administrators can use this API:


        - `id_full_admin`


        - `id_group_admin`


        - `id_readonly_admin`


        - `id_device_admin`'
      tags:
      - SCIM 2 Groups
      parameters:
      - name: orgId
        in: path
        description: The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.
        required: true
        example: e9f9ab27-0459-4cd0-bd72-089bde5a7da6
        schema:
          type: string
      - name: filter
        in: query
        description: 'The url encoded filter. The example content is ''displayName Eq "group1@example.com" or displayName Eq "group2@example.com"''.

          For more filter patterns, see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2. If the value is empty, the API returns all groups under the organization.

          '
        example: displayName Eq "group1%40example.com " or displayName Eq "group2%40example.com "
        schema:
          type: string
      - name: attributes
        in: query
        description: The attributes to return.
        example: displayName
        schema:
          type: string
      - name: excludedAttributes
        in: query
        description: Attributes to be excluded from the return.
        example: members
        schema:
          type: string
      - name: sortBy
        in: query
        description: A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.
        example: displayName
        schema:
          type: string
      - name: sortOrder
        in: query
        description: A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.
        example: ascending
        schema:
          type: string
      - name: startIndex
        in: query
        description: An integer indicating the 1-based index of the first query result. The default is 1.
        example: 1
        schema:
          type: number
      - name: count
        in: query
        description: An integer indicating the desired maximum number of query results per page. The default is 100.
        example: 10
        schema:
          type: number
      - name: includeMembers
        in: query
        description: Default "false". If false, no members returned.
        example: false
        schema:
          type: boolean
      - name: memberType
        in: query
        description: 'Filter the members by member type. Sample data: `user`, `machine`, `group`.'
        example: user
        schema:
          type: string
  /identity/scim/{orgId}/v2/Groups/{groupId}:
    get:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGroupResponse'
              example:
                schemas:
                - urn:ietf:params:scim:schemas:core:2.0:Group
                - urn:scim:schemas:extension:cisco:webexidentity:2.0:Group
                id: cb8f48e4-5db2-496b-b43d-83d8d5a2a4b3
                displayName: wade_test_ccbeca2c-5f25-4c3a-b03c-e3bbc5368405@webex.identity.com
                externalId: test
                members:
                - value: c5349664-9f3d-410b-8bd3-6c31f181f13d
                  type: user
                  example: https://example.com/v2/Users/c5349664-9f3d-410b-8bd3-6c31f181f13d
                  display: A user
                - value: ffd2164c-b938-46dd-8b2f-def6c33b45d0
                  type: group
                  example: https://example.com/v2/Groups/ffd2164c-b938-46dd-8b2f-def6c33b45d0
                  display: A nested group
                meta:
                  resourceType: group
                  created: '2011-08-01T21:32:44.882Z'
                  lastModified: '2011-08-01T21:32:44.882Z'
                  version: W/"e180ee84f0671b1"
                  location: https://example.com/v2/Groups/e9e30dba-f08f-4109-8486-d5c6a331660a
                urn:scim:schemas:extension:cisco:webexidentity:2.0:Group:
                  usage: location
                  inheritances:
                  - type: role
                    value: id_full_admin
                    nested: false
                    scope:
                    - user
                  owners:
                  - value: bb9e77e5-91c3-4006-87c7-c18d885174c7
                  - value: 93e10e81-f836-434c-8e4c-8f496aeef8d5
                  managedBy:
                  - orgId: e82f0522-09b1-49fb-9fff-735fee313456
                    type: user
                    id: 0f0c3024-73dc-4e1f-b4b0-f47e67c0399c
                    role: location_full_admin
                  - orgId: cd828192-269c-4bc7-943b-273555227961
                    type: machine
                    id: 4ecec95a-0493-4df0-bd1c-c97712561077
                    role: id_user_admin
                  provisionSource: AD
                  meta:
                    organizationID: e9f9ab27-0459-4cd0-bd72-089bde5a7da6
        '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 a group
      operationId: Get a group
      description: 'Retrieve details for a group, by ID.


        Optionally, members can be retrieved with this request. The maximum number of members returned is 500.


        <br/>


        **Authorization**


        OAuth token rendered by Identity Broker.


        <br/>


        One of the following OAuth scopes is required:


        - `identity:people_rw`


        - `identity:people_read`


        <br/>


        The following administrators can use this API:


        - `id_full_admin`


        - `id_group_admin`


        - `id_readonly_admin`


        - `id_device_admin`'
      tags:
      - SCIM 2 Groups
      parameters:
      - name: orgId
        in: path
        description: The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.
        required: true
        example: e9f9ab27-0459-4cd0-bd72-089bde5a7da6
        schema:
          type: string
      - name: groupId
        in: path
        description: A unique identifier for the group.
        required: true
        example: cb8f48e4-5db2-496b-b43d-83d8d5a2a4b3
        schema:
          type: string
      - name: excludedAttributes
        in: query
        description: Attributes to be excluded from the return.
        example: members
        schema:
          type: string
    put:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGroupResponse'
              example:
                schemas:
                - urn:ietf:params:scim:schemas:core:2.0:Group
                - urn:scim:schemas:extension:cisco:webexidentity:2.0:Group
                id: w48389cd-4cc3-4a80-8b6d-ecb5632ea117
                displayName: test_Wade_newName@webex.identity.com
                externalId: test_new
                members:
                - value: c5349664-9f3d-410b-8bd3-6c31f181f13d
                  type: user
                  example: https://example.com/v2/Users/c5349664-9f3d-410b-8bd3-6c31f181f13d
                  display: A user
                - value: ffd2164c-b938-46dd-8b2f-def6c33b45d0
                  type: group
                  example: https://example.com/v2/Groups/ffd2164c-b938-46dd-8b2f-def6c33b45d0
                  display: A nested group
                urn:scim:schemas:extension:cisco:webexidentity:2.0:Group:
                  usage: policy
                  inheritances:
                  - type: role
                    value: id_full_admin
                    nested: false
                    scope:
                    - user
                  owners:
                  - value: bb9e77e5-91c3-4006-87c7-c18d885174c7
                  - value: 93e10e81-f836-434c-8e4c-8f496aeef8d5
                  managedBy:
                  - orgId: e82f0522-09b1-49fb-9fff-735fee313456
                    type: user
                    id: 0f0c3024-73dc-4e1f-b4b0-f47e67c0399c
                    role: location_full_admin
                  - orgId: cd828192-269c-4bc7-943b-273555227961
                    type: machine
                    id: 4ecec95a-0493-4df0-bd1c-c97712561077
                    role: id_user_admin
                  provisionSource: AAD
                  meta:
                    organizationID: bb9e77e5-91c3-4006-87c7-c18d885174c7
                meta:
                  resourceType: group
                  location: https://identity.webex.com/identity/scim/bb9e77e5-91c3-4006-87c7-c18d885174c7/v2/Groups/w48389cd-4cc3-4a80-8b6d-ecb5632ea117
                  version: W/"73585827739"
                  created: '2022-11-15T08:21:54.725Z'
                  lastModified: '2022-11-15T08:21:54.725Z'
        '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: Update a group with PUT
      operationId: Update a group with PUT
      description: "Replace the contents of the Group.\n\nSpecify the group ID in the `groupId` parameter in the URI.\n\n<br/>\n\n**Authorization**\n\nOAuth token returned by Identity Broker.\n\n<br/>\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n<br/>\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_group_admin`\n\n<br/>\n\n**Usage**:\n\n1. The input JSON must conform to one of the following schemas:\n    - `urn:ietf:params:scim:schemas:core:2.0:Group`\n    - `urn:scim:schemas:extension:cisco:webexidentity:2.0:Group`\n\n1. Unrecognized schemas (ID/section) are ignored.\n\n1. Read-only attributes provided as input values are ignored.\n\n1. The group `id` is not changed.\n\n1. All attributes are cleaned up if a new value is not provided by the client.\n\n1. The values, `meta` and `created` are not changed."
      tags:
      - SCIM 2 Groups
      parameters:
      - name: orgId
        in: path
        description: The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.
        required: true
        example: e9f9ab27-0459-4cd0-bd72-089bde5a7da6
        schema:
          type: string
      - name: groupId
        in: path
        description: A unique identifier for the group.
        required: true
        example: cb8f48e4-5db2-496b-b43d-83d8d5a2a4b3
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
              schemas:
              - urn:ietf:params:scim:schemas:core:2.0:Group
              - urn:scim:schemas:extension:cisco:webexidentity:2.0:Group
              displayName: group1@example.com
              externalId: test
              members:
              - value: c5349664-9f3d-410b-8bd3-6c31f181f13d
                type: user
              urn:scim:schemas:extension:cisco:webexidentity:2.0:Group:
                usage: policy
                inheritances:
                - type: role
                  value: id_full_admin
                  nested: false
                  scope:
                  - user
                owners:
                - value: c5349664-9f3d-410b-8bd3-6c31f181f13d
                managedBy:
                - orgId: d1349664-9f3d-410b-8bd3-6c31f181f14e
                  type: user
                  id: c5349664-9f3d-410b-8bd3-6c31f181f13d
                  role: location_full_admin
            schema:
              $ref: '#/components/schemas/PutGroup'
    patch:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGroupResponse'
              example:
                schemas:
                - urn:ietf:params:scim:schemas:core:2.0:Group
                - urn:scim:schemas:extension:cisco:webexidentity:2.0:Group
                id: cb8f48e4-5db2-496b-b43d-83d8d5a2a4b3
                displayName: wade_test_ccbeca2c-5f25-4c3

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