{
"opencollection": "1.0.0",
"info": {
"name": "Webex Admin Address Book SCIM 2 Users API",
"version": "1.0.0"
},
"items": [
{
"info": {
"name": "SCIM 2 Users",
"type": "folder"
},
"items": [
{
"info": {
"name": "Search users",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/identity/scim/:orgId/v2/Users",
"params": [
{
"name": "orgId",
"value": "0ae87ade-8c8a-4952-af08-318798958d0c",
"type": "path",
"description": "Webex Identity assigned organization identifier for user's organization."
},
{
"name": "filter",
"value": "userName%20Eq%20%22user1%40example.com%22%20or%20userName%20Eq%20%22user2%40example.com%22",
"type": "query",
"description": "The URL encoded filter. If the value is empty, the API will return all users under the organization.\n\nThe examples below show some search filters:\n\n- `userName` eq \"user1@example.com\"\n\n- `userName` sw \"user1@example\"\n\n- `userName` ew \"example\"\n\n- `phoneNumbers` [ type eq \"mobile\" and value eq \"14170120\"]\n\n- `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq \"0ae87ade-8c8a-4952-af08-318798958d0c\"\n\n- For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).\n\n| **Attributes** | **Operators** |\n|-----|-----|\n| **SCIM Core** | ---- |\n| `id` | eq |\n| `userName` | eq sw ew |\n| `name.familyName` | eq sw ew |\n| `name.givenName` | eq sw |\n| `name.middleName` | eq sw |\n| `name.formatted` | eq sw |\n| `displayName` | eq sw ew |\n| `nickName` | eq sw ew |\n| `emails.display` | eq sw ew |\n| `emails.value` | eq sw ew |\n| `phoneNumbers.value` | eq sw ew |\n| `phoneNumbers.display` | eq sw ew |\n| **Enterprise Extensions** | ---- |\n| `employeeNumber` | eq sw ew |\n| `costCenter` | eq sw ew |\n| `organization` | eq sw ew |\n| `division` | eq sw ew |\n| `department` | eq sw ew |\n| `manager.value` | eq |\n| `manager.displayName` | eq sw ew |"
},
{
"name": "attributes",
"value": "urn:ietf:params:scim:schemas:core:2.0:User",
"type": "query",
"description": "A multi-valued list of string names for resource attributes to return in the response, like 'userName,department,emails'. It supports the SCIM id 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,userName'. The default is empty, all attributes will be returned"
},
{
"name": "excludedAttributes",
"value": "nickName,userType",
"type": "query",
"description": "A multi-valued list of strings names for resource attributes to be removed from the default set of attributes to return. The default is empty, all attributes will be returned"
},
{
"name": "sortBy",
"value": "userName",
"type": "query",
"description": "A string for the attribute whose value can be used to order the returned responses. Now we only allow `userName`, `id`, `meta.lastModified` to sort."
},
{
"name": "sortOrder",
"value": "ascending",
"type": "query",
"description": "A string for the order in which the 'sortBy' parameter is applied. Allowed values are 'ascending' and 'descending'."
},
{
"name": "startIndex",
"value": "1",
"type": "query",
"description": "An integer for the 1-based index of the first query result. The default is 1."
},
{
"name": "count",
"value": "10",
"type": "query",
"description": "An integer for the maximum number of query results per page. The default is 100."
},
{
"name": "returnGroups",
"value": "false",
"type": "query",
"description": "Define whether the group information needs to be returned. The default is false."
},
{
"name": "includeGroupDetails",
"value": "false",
"type": "query",
"description": "Define whether the group information with details needs to be returned. The default is false."
},
{
"name": "groupUsageTypes",
"value": "``",
"type": "query",
"description": "Returns groups with details of the specified group type."
}
]
},
"docs": "
\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_user_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`\n\n
"
},
{
"info": {
"name": "Create a user",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/identity/scim/:orgId/v2/Users",
"params": [
{
"name": "orgId",
"value": "0ae87ade-8c8a-4952-af08-318798958d0c",
"type": "path",
"description": "Webex Identity assigned organization identifier for user's organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "The SCIM 2 /Users API provides a programmatic way to manage users in Webex Identity using The Internet Engineering Task Force standard SCIM 2.0 standard as specified by [RFC 7643 SCIM 2.0 Core Schema ](https://datatracker.ietf.org/doc/html/rfc7643) and [RFC 7644 SCIM 2.0 Core Protocol](https://datatracker.ietf.org/doc/html/rfc7644). The WebEx SCIM 2.0 APIs allow clients supporting the SCIM 2.0 standard to manage users, and groups within Webex. Webex supports the following SCIM 2.0 Schemas:\n\n•"
},
{
"info": {
"name": "Get a user",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId",
"params": [
{
"name": "orgId",
"value": "0ae87ade-8c8a-4952-af08-318798958d0c",
"type": "path",
"description": "Webex Identity assigned organization identifier for user's organization."
},
{
"name": "userId",
"value": "3426a8e3-d414-4bf0-a493-4f6787632a13",
"type": "path",
"description": "Webex Identity assigned user identifier."
}
]
},
"docs": "
\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_user_admin`\n\n- `id_readonly_admin`\n\n- `id_device_admin`\n\n
"
},
{
"info": {
"name": "Update a user with PUT",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId",
"params": [
{
"name": "orgId",
"value": "0ae87ade-8c8a-4952-af08-318798958d0c",
"type": "path",
"description": "Webex Identity assigned organization identifier for user's organization."
},
{
"name": "userId",
"value": "3426a8e3-d414-4bf0-a493-4f6787632a13",
"type": "path",
"description": "Webex Identity assigned user identifier."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
\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_user_admin`\n\n
\n\n**Usage**:\n\n1. Input JSON must contain schema: \"urn:ietf:params:scim:schemas:core:2.0:User\".\n\n2. Support 3 schemas :\n - \"urn:ietf:params:scim:schemas:core:2.0:User\"\n - \"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User\"\n - \"urn:scim:sc"
},
{
"info": {
"name": "Update a user with PATCH",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId",
"params": [
{
"name": "orgId",
"value": "0ae87ade-8c8a-4952-af08-318798958d0c",
"type": "path",
"description": "Webex Identity assigned organization identifier for user's organization."
},
{
"name": "userId",
"value": "3426a8e3-d414-4bf0-a493-4f6787632a13",
"type": "path",
"description": "Webex Identity assigned user identifier."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "
\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_user_admin`\n\n
\n\n**Usage**:\n\n1. The PATCH API replaces individual attributes and roles of the user's data in the request body.\n The PATCH API supports `add`, `remove`, and `replace` operations on any individual\n attribute or role allowing only specific attributes of"
},
{
"info": {
"name": "Delete a user",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/identity/scim/:orgId/v2/Users/:userId",
"params": [
{
"name": "orgId",
"value": "0ae87ade-8c8a-4952-af08-318798958d0c",
"type": "path",
"description": "Webex Identity assigned organization identifier for user's organization."
},
{
"name": "userId",
"value": "3426a8e3-d414-4bf0-a493-4f6787632a13",
"type": "path",
"description": "Webex Identity assigned user identifier."
}
]
},
"docs": "
\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_user_admin`\n\n
"
},
{
"info": {
"name": "Get Me",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/identity/scim/v2/Users/me"
},
"docs": "
\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 API can be used by any user to retrieve user information using their own access token.\n\n
"
}
]
}
],
"bundled": true
}