Search groups
Retrieve a list of groups in the organization.
Long result sets are split into pages.
Authorization
An OAuth token rendered by Identity Broker.
One of the following OAuth scopes is required:
identity:people_rwidentity:people_read
The following administrators can use this API:
id_full_adminid_group_adminid_readonly_adminid_device_admin
URI Parameters
The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used.
Query Parameters
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.
Attributes to be excluded from the return.
The attributes to return.
An integer indicating the 1-based index of the first query result. The default is 1.
An integer indicating the desired maximum number of query results per page. The default is 100.
A string indicating the attribute whose value be used to order the returned responses. Now we only allow displayName, id, meta.lastModified to sort.
A string indicating the order in which the sortBy parameter is applied. Allowed values are ascending and descending.
Default "false". If false, no members returned.
Filter the members by member type. Sample data: user, machine, group.
Response Properties
Input JSON schemas.
Total number of groups in search results.
The total number of items in a paged result.
Start at the one-based offset in the list of matching contacts.
An array of group objects.
Input JSON schemas.
A human-readable name for the group.
A unique identifier for the group.
An identifier for the resource as defined by the provisioning client.
A list of members of this group.
A label indicating the type of resource, for example user, machine, or group.
The identifier of the member of this Group.
A human-readable name for the group member.
The URI corresponding to a SCIM resource that is a member of this Group.
Response metadata.
The date and time the group was created.
The date and time the group was last changed.
The version of the group.
The resource itself.
The Cisco extention of SCIM 2
The identifier of this group.
The owners of this group.
The identifier of the owner of this Group.
A list of delegates of this group.
The Organization identifier of the resource.
The resource type.
The identifier of the resource.
The delegated role.
The identifier of the source.
Response metadata.
The ID of the organization to which this group belongs.
Response Codes
The list below describes the common success and error responses you should expect from the API:
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | 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 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | 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 | Gone | The requested resource is no longer available. |
| 415 | 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 | 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 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | 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 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Query Parameters
- 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.
- Attributes to be excluded from the return.
- The attributes to return.
- An integer indicating the 1-based index of the first query result. The default is 1.
- An integer indicating the desired maximum number of query results per page. The default is 100.
- A string indicating the attribute whose value be used to order the returned responses. Now we only allow `displayName, id, meta.lastModified` to sort.
- A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`.
- Default "false". If false, no members returned.
- Filter the members by member type. Sample data: `user`, `machine`, `group`.
{
"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",
"$ref": "https://example.com/v2/Users/c5349664-9f3d-410b-8bd3-6c31f181f13d",
"display": "A user"
},
{
"value": "ffd2164c-b938-46dd-8b2f-def6c33b45d0",
"type": "group",
"$ref": "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",
"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",
"$ref": "https://example.com/v2/Users/c5349664-9f3d-410b-8bd3-6c31f181f13d",
"display": "A user"
},
{
"value": "ffd2164c-b938-46dd-8b2f-def6c33b45d0",
"type": "group",
"$ref": "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"
}
}
}
]
}