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
\n\n**Authorization**\n\nOAuth token returned by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_group_admin`\n\n
\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).
**Authorization** An OAuth token rendered by Identity Broker.
One of the following OAuth scopes is required: - `identity:people_rw` - `identity:people_read`
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.
**Authorization** OAuth token rendered by Identity Broker.
One of the following OAuth scopes is required: - `identity:people_rw` - `identity:people_read`
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
\n\n**Authorization**\n\nOAuth token returned by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_group_admin`\n\n
\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-4c3a-b03c-e3bbc5368405@webex.identity.com externalId: test members: - value: 9836fa05-21f4-4fbc-8863-8eaf3dfbabe7 type: user example: https://example.com/v2/Users/9836fa05-21f4-4fbc-8863-8eaf3dfbabe7 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: Update a group with PATCH operationId: Update a group with PATCH description: "Update group attributes with PATCH.\n\nSpecify the group ID in the `groupId` parameter in the URI.\n\n
\n\n**Authorization**\n\nOAuth token returned by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_group_admin`\n\n
\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. Each operation on an attribute must be compatible with the attribute's mutability.\n\n1. Each PATCH operation represents a single action to be applied to the\n same SCIM resource specified by the request URI. Operations are\n applied sequentially in the order they appear in the array. Each\n operation in the sequence is applied to the target resource; the\n resulting resource becomes the target of the next operation.\n Evaluation continues until all operations are successfully applied or\n until an error condition is encountered.\n\n
\n\n**Add operations**:\n\nThe `add` operation is used to add a new attribute value to an existing resource. The operation must contain a `value` member whose content specifies the value to be added. The value may be a quoted value, or it may be a JSON object containing the sub-attributes of the complex attribute specified in the operation's `path`. The result of the add operation depends upon the target location indicated by `path` references:\n\n
\n\n- If omitted, the target location is assumed to be the resource itself. The `value` parameter contains a set of attributes to be added to the resource.\n\n- If the target location does not exist, the attribute and value are added.\n\n- If the target location specifies a complex attribute, a set of sub-attributes shall be specified in the `value` parameter.\n\n- If the target location specifies a multi-valued attribute, a new value is added to the attribute.\n\n- If the target location specifies a single-valued attribute, the existing value is replaced.\n\n- If the target location specifies an attribute that does not exist (has no value), the attribute is added with the new value.\n\n- If the target location exists, the value is replaced.\n\n- If the target location already contains the value specified, no changes should be made to the resource.\n\n
\n\n**Replace operations**:\n\nThe `replace` operation replaces the value at the target location specified by the `path`. The operation performs the following functions, depending on the target location specified by `path`:\n\n
\n\n- If the `path` parameter is omitted, the target is assumed to be the resource itself. In this case, the `value` attribute shall contain a list of one or more attributes that are to be replaced.\n\n- If the target location is a single-value attribute, the value of the attribute is replaced.\n\n- If the target location is a multi-valued attribute and no filter is specified, the attribute and all values are replaced.\n\n- If the target location path specifies an attribute that does not exist, the service provider shall treat the operation as an \"add\".\n\n- If the target location specifies a complex attribute, a set of sub-attributes SHALL be specified in the `value` parameter, which replaces any existing values or adds where an attribute did not previously exist. Sub-attributes that are not specified in the `value` parameters are left unchanged.\n\n- If the target location is a multi-valued attribute and a value selection (\"valuePath\") filter is specified that matches one or more values of the multi-valued attribute, then all matching record values will be replaced.\n\n- If the target location is a complex multi-valued attribute with a value selection filter (\"valuePath\") and a specific sub-attribute (e.g., \"addresses[type eq \"work\"].streetAddress\"), the matching sub-attribute of all matching records is replaced.\n\n- If the target location is a multi-valued attribute for which a value selection filter (\"valuePath\") has been supplied and no record match was made, the service provider will indicate the failure by returning HTTP status code 400 and a `scimType` error code of `noTarget`.\n\n
\n\n**Remove operations**:\n\nThe `remove` operation removes the value at the target location specified by the required attribute `path`. The operation performs the following functions, depending on the target location specified by `path`:\n\n
\n\n- If `path` is unspecified, the operation fails with HTTP status code 400 and a \"scimType\" error code of \"noTarget\".\n\n- If the target location is a single-value attribute, the attribute and its associated value is removed, and the attribute will be considered unassigned.\n\n- If the target location is a multi-valued attribute and no filter is specified, the attribute and all values are removed, and the attribute SHALL be considered unassigned.\n\n- If the target location is a multi-valued attribute and a complex filter is specified comparing a `value`, the values matched by the filter are removed. If no other values remain after the removal of the selected values, the multi-valued attribute will be considered unassigned.\n\n- If the target location is a complex multi-valued attribute and a complex filter is specified based on the attribute`s sub-attributes, the matching records are removed. Sub-attributes whose values have been removed will be considered unassigned. If the complex multi-valued attribute has no remaining records, the attribute will be considered unassigned." 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:api:messages:2.0:PatchOp Operations: - op: add path: urn:scim:schemas:extension:cisco:webexidentity:2.0:Group.inheritances value: - type: role value: id_user_admin nested: false scope: - user schema: $ref: '#/components/schemas/PatchGroup' delete: responses: '204': description: No Content headers: {} content: {} '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: Delete a group operationId: Delete a group description: 'Remove a group from the system. Specify the group ID in the `groupId` parameter in the URI.
**Authorization** OAuth token rendered by Identity Broker.
One of the following OAuth scopes is required: - `identity:people_rw`
The following administrators can use this API: - `id_full_admin` - `id_group_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 /identity/scim/{orgId}/v2/Groups/{groupId}/Members: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GroupMemberResponse' example: schemas: - urn:scim:schemas:extension:cisco:webexidentity:2.0:GroupMembers memberSize: 2 displayName: group_name itemsPerPage: 2 startIndex: 1 members: - value: c5349664-9f3d-410b-8bd3-6c31f181f13d type: user display: A user - value: ffd2164c-b938-46dd-8b2f-def6c33b45d0 type: group display: A nested group '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 Members operationId: Get Group Members description: 'Returns the members of a group. - The default maximum number of members returned is 500. - Control parameters are available to page through the members and to control the size of the results. - Long result sets are split into [pages](/docs/basics#pagination). **Note** Location groups are different from SCIM groups. You cannot search for identities in a location via groups.
**Authorization** OAuth token returned by the Identity Broker.
One of the following OAuth scopes is required: - `identity:people_rw` - `identity:people_read`
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: startIndex in: query description: The index to start for group pagination. example: 1 schema: type: number - name: count in: query description: Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500. example: 100 schema: type: number - name: memberType in: query description: 'Filter the members by member type. Sample data: `user`, `machine`, `group`.' example: user schema: type: string components: schemas: PostGroup: type: object required: - schemas - displayName properties: schemas: type: array items: type: string example: urn:ietf:params:scim:schemas:core:2.0:Group,urn:scim:schemas:extension:cisco:webexidentity:2.0:Group description: Input JSON schemas. displayName: type: string example: group1@example.com description: A human-readable name for the Group. externalId: type: string example: test description: An identifier for the resource as defined by the provisioning client. members: type: array items: $ref: '#/components/schemas/GroupMemberObject' description: A list of members of this group. urn:scim:schemas:extension:cisco:webexidentity:2.0:Group: type: object properties: usage: type: string example: policy description: The identifier of this Group. owners: type: array items: type: object properties: value: type: string example: c5349664-9f3d-410b-8bd3-6c31f181f13d description: The identifier of the owner of this group. description: The owners of this group. inheritances: type: array items: $ref: '#/components/schemas/GroupInheritancesObject' description: An array of inheritances managedBy: type: array items: $ref: '#/components/schemas/ManagedByObject' description: A list of delegates of this group. description: The Cisco extension of SCIM 2. PatchGroup: type: object required: - schemas - Operations properties: schemas: type: array items: type: string example: urn:ietf:params:scim:api:messages:2.0:PatchOp description: Input JSON schemas. Operations: type: array items: type: object required: - op properties: op: type: string enum: - add - replace - remove description: The operation to perform. path: type: string example: displayName description: A string containing an attribute path describing the target of the operation. value: type: array items: $ref: '#/components/schemas/GroupInheritancesObject' description: New value. description: A list of patch operations. PutGroup: type: object required: - schemas - displayName properties: schemas: type: array items: type: string example: urn:ietf:params:scim:schemas:core:2.0:Group,urn:scim:schemas:extension:cisco:webexidentity:2.0:Group description: Input JSON schemas. displayName: type: string example: group1@example.com description: A human-readable name for the group. externalId: type: string example: test description: An identifier for the resource as defined by the provisioning client. members: type: array items: $ref: '#/components/schemas/GroupMemberObject' description: A list of members of this group. urn:scim:schemas:extension:cisco:webexidentity:2.0:Group: type: object properties: usage: type: string example: policy description: The identifier of this Group. owners: type: array items: type: object properties: value: type: string example: c5349664-9f3d-410b-8bd3-6c31f181f13d description: The identifier of the owner of this group. description: The owners of this group. inheritances: type: array items: $ref: '#/components/schemas/GroupInheritancesObject' description: An array of inheritances managedBy: type: array items: $ref: '#/components/schemas/ManagedByObject' description: A list of delegates of this group. description: The Cisco extension of SCIM 2. MetaObject: type: object description: Response metadata. required: - created - lastModified - version - location properties: resourceType: type: string example: User organizationID: type: string example: The organization ID of the user created: type: string example: '2023-01-11T17:38:31.605Z' description: The date and time the group was created. lastModified: type: string example: '2023-01-11T17:38:31.605Z' description: The date and time the group was last changed. version: type: string example: '"W\/\"e180ee84f0671b1\""' description: The version of the user. location: type: string example: https://webexapi.com/identity/scim/0ae87ade-8c8a-4952-af08-318798958d0c/v2/Users/3426a8e3-d414-4bf0-a493-4f6787632a13 description: The resource itself. ManagedByObject: type: object properties: orgId: type: string example: d1349664-9f3d-410b-8bd3-6c31f181f14e description: The Organization identifier of the resource. type: type: string example: user description: The resource type. id: type: string example: c5349664-9f3d-410b-8bd3-6c31f181f13d description: The identifier of the resource. role: type: string example: location_full_admin description: The delegated role. GroupMemberObject: type: object properties: value: type: string example: c5349664-9f3d-410b-8bd3-6c31f181f13d description: The identifier of the member of this Group. type: type: string example: user description: A label indicating the type of resource, for example user, machine, or group. 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: group1@example.com 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. SearchGroupResponse: type: object required: - schemas properties: schemas: type: array items: type: string example: urn:scim:schemas:extension:cisco:webexidentity:2.0:GroupMembers description: Input JSON schemas. memberSize: 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 contacts. Resources: type: array items: $ref: '#/components/schemas/GetGroupResponse' description: An array of group objects. GroupInheritancesObject: type: object properties: type: type: string enum: - role example: role description: Type of inheritance. Currently, only the `role` type is supported. Only `policy` usage supports inheritance. value: type: string example: id_full_admin description: The value of the inheritance. For the role type, this can be role names such as `id_full_admin`, `id_user_admin`, etc. nested: type: boolean example: false description: Indicates whether this inheritance is nested. scope: type: array items: type: string example: - user description: Indicates which types of entities can inherit this property. GetGroupResponse: type: object required: - schemas - displayName - id - meta properties: schemas: type: array items: type: string example: urn:ietf:params:scim:schemas:core:2.0:Group,urn:scim:schemas:extension:cisco:webexidentity:2.0:Group description: Input JSON schemas. displayName: type: string example: group1@example.com description: A human-readable name for the group. id: type: string example: cb8f48e4-5db2-496b-b43d-83d8d5a2a4b3 description: A unique identifier for the group. externalId: type: string example: test description: An identifier for the resource as defined by the provisioning client. 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. $ref: type: string example: https://example.com/v2/Users/c5349664-9f3d-410b-8bd3-6c31f181f13d description: The URI corresponding to a SCIM resource that is a member of this Group. description: A list of members of this group. meta: $ref: '#/components/schemas/MetaObject' description: Response metadata. urn:scim:schemas:extension:cisco:webexidentity:2.0:Group: type: object required: - usage - provisionSource - meta properties: usage: type: string example: location description: The identifier of this group. owners: type: array items: type: object properties: value: type: string example: c5349664-9f3d-410b-8bd3-6c31f181f13d description: The identifier of the owner of this Group. description: The owners of this group. managedBy: type: array items: $ref: '#/components/schemas/ManagedByObject' description: A list of delegates of this group. provisionSource: type: string example: AD description: The identifier of the source. inheritances: type: array items: $ref: '#/components/schemas/GroupInheritancesObject' description: An array of inheritances meta: type: object required: - organizationID properties: organizationID: type: string example: e9f9ab27-0459-4cd0-bd72-089bde5a7da6 description: The ID of the organization to which this group belongs. description: Response metadata. description: The Cisco extention of SCIM 2 securitySchemes: oauth2: flows: authorizationCode: authorizationUrl: / scopes: {} tokenUrl: / type: oauth2 bearer-key: type: http description: e.g. Bearer YOUR_AUTHORIZATION_TOKEN scheme: bearer bearerFormat: JWT bearerAuth: type: oauth2 description: OAuth 2.0 Bearer token authentication flows: authorizationCode: authorizationUrl: https://webexapis.com/v1/authorize tokenUrl: https://webexapis.com/v1/access_token scopes: spark:applications_token: Create access tokens for Service Apps