{
"opencollection": "1.0.0",
"info": {
"name": "Webex Admin Address Book SCIM 2 Groups API",
"version": "1.0.0"
},
"items": [
{
"info": {
"name": "SCIM 2 Groups",
"type": "folder"
},
"items": [
{
"info": {
"name": "Search groups",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/identity/scim/:orgId/v2/Groups",
"params": [
{
"name": "orgId",
"value": "e9f9ab27-0459-4cd0-bd72-089bde5a7da6",
"type": "path",
"description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used."
},
{
"name": "filter",
"value": "displayName Eq \"group1%40example.com \" or displayName Eq \"group2%40example.com \"",
"type": "query",
"description": "The url encoded filter. The example content is 'displayName Eq \"group1@example.com\" or displayName Eq \"group2@example.com\"'.\nFor 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.\n"
},
{
"name": "attributes",
"value": "displayName",
"type": "query",
"description": "The attributes to return."
},
{
"name": "excludedAttributes",
"value": "members",
"type": "query",
"description": "Attributes to be excluded from the return."
},
{
"name": "sortBy",
"value": "displayName",
"type": "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."
},
{
"name": "sortOrder",
"value": "ascending",
"type": "query",
"description": "A string indicating the order in which the `sortBy` parameter is applied. Allowed values are `ascending` and `descending`."
},
{
"name": "startIndex",
"value": "1",
"type": "query",
"description": "An integer indicating the 1-based index of the first query result. The default is 1."
},
{
"name": "count",
"value": "10",
"type": "query",
"description": "An integer indicating the desired maximum number of query results per page. The default is 100."
},
{
"name": "includeMembers",
"value": "false",
"type": "query",
"description": "Default \"false\". If false, no members returned."
},
{
"name": "memberType",
"value": "user",
"type": "query",
"description": "Filter the members by member type. Sample data: `user`, `machine`, `group`."
}
]
},
"docs": "Retrieve a list of groups in the organization.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n
\n\n**Authorization**\n\nAn OAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n- `identity:people_read`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_group_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`"
},
{
"info": {
"name": "Create a group",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/identity/scim/:orgId/v2/Groups",
"params": [
{
"name": "orgId",
"value": "e9f9ab27-0459-4cd0-bd72-089bde5a7da6",
"type": "path",
"description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "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:schema"
},
{
"info": {
"name": "Get a group",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId",
"params": [
{
"name": "orgId",
"value": "e9f9ab27-0459-4cd0-bd72-089bde5a7da6",
"type": "path",
"description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used."
},
{
"name": "groupId",
"value": "cb8f48e4-5db2-496b-b43d-83d8d5a2a4b3",
"type": "path",
"description": "A unique identifier for the group."
},
{
"name": "excludedAttributes",
"value": "members",
"type": "query",
"description": "Attributes to be excluded from the return."
}
]
},
"docs": "Retrieve details for a group, by ID.\n\nOptionally, members can be retrieved with this request. The maximum number of members returned is 500.\n\n
\n\n**Authorization**\n\nOAuth token rendered by Identity Broker.\n\n
\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n- `identity:people_read`\n\n
\n\nThe following administrators can use this API:\n\n- `id_full_admin`\n\n- `id_group_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`"
},
{
"info": {
"name": "Update a group with PUT",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId",
"params": [
{
"name": "orgId",
"value": "e9f9ab27-0459-4cd0-bd72-089bde5a7da6",
"type": "path",
"description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used."
},
{
"name": "groupId",
"value": "cb8f48e4-5db2-496b-b43d-83d8d5a2a4b3",
"type": "path",
"description": "A unique identifier for the group."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "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:ext"
},
{
"info": {
"name": "Update a group with PATCH",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId",
"params": [
{
"name": "orgId",
"value": "e9f9ab27-0459-4cd0-bd72-089bde5a7da6",
"type": "path",
"description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used."
},
{
"name": "groupId",
"value": "cb8f48e4-5db2-496b-b43d-83d8d5a2a4b3",
"type": "path",
"description": "A unique identifier for the group."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "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:ex"
},
{
"info": {
"name": "Delete a group",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId",
"params": [
{
"name": "orgId",
"value": "e9f9ab27-0459-4cd0-bd72-089bde5a7da6",
"type": "path",
"description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used."
},
{
"name": "groupId",
"value": "cb8f48e4-5db2-496b-b43d-83d8d5a2a4b3",
"type": "path",
"description": "A unique identifier for the group."
}
]
},
"docs": "Remove a group from the system.\n\nSpecify the group ID in the `groupId` parameter in the URI.\n\n
\n\n**Authorization**\n\nOAuth token rendered 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`"
},
{
"info": {
"name": "Get Group Members",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/identity/scim/:orgId/v2/Groups/:groupId/Members",
"params": [
{
"name": "orgId",
"value": "e9f9ab27-0459-4cd0-bd72-089bde5a7da6",
"type": "path",
"description": "The ID of the organization to which this group belongs. If not specified, the organization ID from the OAuth token is used."
},
{
"name": "groupId",
"value": "cb8f48e4-5db2-496b-b43d-83d8d5a2a4b3",
"type": "path",
"description": "A unique identifier for the group."
},
{
"name": "startIndex",
"value": "1",
"type": "query",
"description": "The index to start for group pagination."
},
{
"name": "count",
"value": "100",
"type": "query",
"description": "Non-negative integer that specifies the desired number of search results per page. The maximum value for the count is 500."
},
{
"name": "memberType",
"value": "user",
"type": "query",
"description": "Filter the members by member type. Sample data: `user`, `machine`, `group`."
}
]
},
"docs": "Returns the members of a group.\n\n- The default maximum number of members returned is 500.\n\n- Control parameters are available to page through the members and to control the size of the results.\n\n- Long result sets are split into [pages](/docs/basics#pagination).\n\n**Note**\nLocation groups are different from SCIM groups. You cannot search for identities in a location via groups.\n\n
\n\n**Authorization**\n\nOAuth token returned by the Identity Broker.\n\n
\n\nOne of the following OAuth scopes is req"
}
]
}
],
"bundled": true
}