openapi: 3.0.0 info: title: Webex Admin Address Book SCIM 2 Users 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 Users paths: /identity/scim/{orgId}/v2/Users: post: responses: '201': description: Created headers: {} content: application/json: schema: $ref: '#/components/schemas/GetUserResponse' example: schemas: - urn:ietf:params:scim:schemas:core:2.0:User - urn:scim:schemas:extension:cisco:webexidentity:2.0:User - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User id: 3426a8e3-d414-4bf0-a493-4f6787632a13 userName: user1@example.com active: true roles: - value: id_full_admin type: cirole display: Full administrator name: familyName: Joestar givenName: Jonathan middleName: Jane honorificPrefix: Mr. honorificSuffix: III displayName: Mr. Jonathan Jane Joestar, III nickName: JoJo emails: - value: user1@example.home.com type: home display: home email description - value: user1@example.com type: work primary: true userType: user profileUrl: https://jojowiki.com/Jonathan_Joestar title: Sales manager preferredLanguage: en_US locale: en_US externalId: externalIdValue timezone: America/Los_Angeles phoneNumbers: - value: 400 123 1234 type: work primary: true display: work phone number photos: - value: https://photos.example.com/profilephoto/72930000000Ccne/F type: photo primary: true display: photo description addresses: - type: work streetAddress: 100 Universal City Plaza locality: Hollywood region: CA postalCode: '91608' country: US urn:ietf:params:scim:schemas:extension:enterprise:2.0:User: employeeNumber: 518-8888-888 costCenter: costCenter 123 organization: Cisco webexidentity division: division 456 department: department 789 manager: value: b5717a4a-0169-43b2-ac3c-db20ba4e72cd displayName: Identity Administrator example: https://integration.webexapis.com/identity/scim/0ae87ade-8c8a-4952-af08-318798958d0c/v2/Users/b5717a4a-0169-43b2-ac3c-db20ba4e72cd urn:scim:schemas:extension:cisco:webexidentity:2.0:User: accountStatus: - active sipAddresses: - value: sipAddress value1 type: enterprise primary: true display: sipAddress1 description managedOrgs: - orgId: 75fe2995-24f5-4831-8d2c-1c2f8255912e role: id_full_admin managedGroups: - orgId: 75fe2995-24f5-4831-8d2c-1c2f8255912e groupId: d178e396-aa06-42cd-ab98-5124eb3b1926 role: id_full_admin externalAttribute1: - source: Source.1_7ddf1f2c-2985-4c37-a450-d58bbc201750 value: externalAttribute1_value externalAttribute2: - source: Source.2_7ddf1f2c-2985-4c37-a450-d58bbc201750 value: externalAttribute2_value extensionAttribute1: - extensionAttribute1_Item1 - extensionAttribute1_Item2 extensionAttribute2: - extensionAttribute2_Item1 - extensionAttribute2_Item2 - extensionAttribute2_Item3 meta: organizationId: 0ae87ade-8c8a-4952-af08-318798958d0c meta: resourceType: User location: http://integration.webexapis.com/identity/scim/0ae87ade-8c8a-4952-af08-318798958d0c/v2/Users/3426a8e3-d414-4bf0-a493-4f6787632a13 version: W/"76678575420" created: '2023-01-11T17:38:31.605Z' lastModified: '2023-01-11T17:38:31.605Z' '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 user operationId: Create a user description: "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• urn:ietf:params:scim:schemas:core:2.0:User\n\n• urn:ietf:params:scim:schemas:extension:enterprise:2.0:User\n\n• urn:scim:schemas:extension:cisco:webexidentity:2.0:User\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_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:schemas:extension:cisco:webexidentity:2.0:User\"\n\n3. Unrecognized schemas (ID/section) are ignored.\n\n4. Read-only attributes provided as input values are ignored.\n\n The following roles cannot be assigned to a user:\n\n1. Location Admin\n\n2. Webex Site Admin" tags: - SCIM 2 Users parameters: - name: orgId in: path description: Webex Identity assigned organization identifier for user's organization. required: true example: 0ae87ade-8c8a-4952-af08-318798958d0c schema: type: string requestBody: content: application/json: example: schemas: - urn:ietf:params:scim:schemas:core:2.0:User - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User - urn:scim:schemas:extension:cisco:webexidentity:2.0:User userName: user1@example.com userType: user title: Sales manager active: true preferredLanguage: en_US locale: en_US timezone: America/Los_Angeles profileUrl: https://jojowiki.com/Jonathan_Joestar externalId: externalIdValue displayName: Mr. Jonathan Jane Joestar, III nickName: JoJo name: givenName: Sarah familyName: Henderson middleName: Jane honorificPrefix: Mr. honorificSuffix: III roles: - value: id_full_admin type: cirole display: Full administrator phoneNumbers: - value: 400 123 1234 type: work display: work phone number primary: true photos: - value: https://photos.example.com/profilephoto/72930000000Ccne/F type: photo display: photo description primary: true addresses: - type: work streetAddress: 100 Universal City Plaza locality: Hollywood region: CA postalCode: '91608' country: US emails: - value: user1@example.home.com type: home display: home email description primary: false urn:ietf:params:scim:schemas:extension:enterprise:2.0:User: costCenter: costCenter 123 organization: Cisco webexidentity division: division 456 department: department 789 employeeNumber: 518-8888-888 manager: value: b5717a4a-0169-43b2-ac3c-db20ba4e72cd urn:scim:schemas:extension:cisco:webexidentity:2.0:User: accountStatus: active sipAddresses: - value: sipAddress value1 type: enterprise display: sipAddress1 description primary: true managedOrgs: - orgId: 75fe2995-24f5-4831-8d2c-1c2f8255912e role: id_full_admin managedGroups: - orgId: 0ae87ade-8c8a-4952-af08-318798958d0c groupId: 3936af3e-15ff-43d1-9ef5-66c569ef34f5 role: location_admin extensionAttribute*: [] externalAttribute*: - source: Source.1_7ddf1f2c-2985-4c37-a450-d58bbc201750 value: externalAttribute1_value schema: $ref: '#/components/schemas/PostUser' get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/SearchUserResponse' '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 users operationId: Search users description: '
**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_user_admin` - `id_readonly_admin` - `id_device_admin`
' tags: - SCIM 2 Users parameters: - name: orgId in: path description: Webex Identity assigned organization identifier for user's organization. required: true example: 0ae87ade-8c8a-4952-af08-318798958d0c schema: type: string - name: filter in: query description: 'The URL encoded filter. If the value is empty, the API will return all users under the organization. The examples below show some search filters: - `userName` eq "user1@example.com" - `userName` sw "user1@example" - `userName` ew "example" - `phoneNumbers` [ type eq "mobile" and value eq "14170120"] - `urn:scim:schemas:extension:cisco:webexidentity:2.0:User:meta.organizationId` eq "0ae87ade-8c8a-4952-af08-318798958d0c" - For more filter patterns, please check [filtering](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2). | **Attributes** | **Operators** | |-----|-----| | **SCIM Core**                              | ---- | | `id` | eq | | `userName` | eq sw ew | | `name.familyName` | eq sw ew | | `name.givenName` | eq sw | | `name.middleName` | eq sw | | `name.formatted` | eq sw | | `displayName` | eq sw ew | | `nickName` | eq sw ew | | `emails.display` | eq sw ew | | `emails.value` | eq sw ew | | `phoneNumbers.value` | eq sw ew | | `phoneNumbers.display` | eq sw ew | | **Enterprise Extensions** | ---- | | `employeeNumber` | eq sw ew | | `costCenter` | eq sw ew | | `organization` | eq sw ew | | `division` | eq sw ew | | `department` | eq sw ew | | `manager.value` | eq | | `manager.displayName` | eq sw ew |' example: userName%20Eq%20%22user1%40example.com%22%20or%20userName%20Eq%20%22user2%40example.com%22 schema: type: string - name: attributes in: 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 example: urn:ietf:params:scim:schemas:core:2.0:User schema: type: string - name: excludedAttributes in: 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 example: nickName,userType schema: type: string - name: sortBy in: 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. example: userName schema: type: string - name: sortOrder in: query description: A string for 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 for the 1-based index of the first query result. The default is 1. example: '1' schema: type: string - name: count in: query description: An integer for the maximum number of query results per page. The default is 100. example: '10' schema: type: string - name: returnGroups in: query description: Define whether the group information needs to be returned. The default is false. example: 'false' schema: type: string - name: includeGroupDetails in: query description: Define whether the group information with details needs to be returned. The default is false. example: 'false' schema: type: string - name: groupUsageTypes in: query description: Returns groups with details of the specified group type. example: '``' schema: type: string /identity/scim/{orgId}/v2/Users/{userId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetUserResponse' '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 user operationId: Get a user description: '
**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_user_admin` - `id_readonly_admin` - `id_device_admin`
' tags: - SCIM 2 Users parameters: - name: orgId in: path description: Webex Identity assigned organization identifier for user's organization. required: true example: 0ae87ade-8c8a-4952-af08-318798958d0c schema: type: string - name: userId in: path description: Webex Identity assigned user identifier. required: true example: 3426a8e3-d414-4bf0-a493-4f6787632a13 schema: type: string put: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetUserResponse' '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 user with PUT operationId: Update a user with PUT description: "
\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:schemas:extension:cisco:webexidentity:2.0:User\"\n\n3. Unrecognized schemas (ID/section) are ignored.\n\n4. Read-only attributes provided as input values are ignored.\n\n5. User `id` will not be changed.\n\n6. `meta`.`created` will not be changed.\n\n7. The PUT API replaces the contents of the user's data with the data in the request body. All attributes specified in the request body will replace all existing attributes for the `userId` specified in the URL. Should you wish to replace or change some attributes as opposed to all attributes please refer to the SCIM PATCH operation https://developer.webex.com/docs/api/v1/scim2-user/update-a-user-with-patch." tags: - SCIM 2 Users parameters: - name: orgId in: path description: Webex Identity assigned organization identifier for user's organization. required: true example: 0ae87ade-8c8a-4952-af08-318798958d0c schema: type: string - name: userId in: path description: Webex Identity assigned user identifier. required: true example: 3426a8e3-d414-4bf0-a493-4f6787632a13 schema: type: string requestBody: content: application/json: example: schemas: - urn:ietf:params:scim:schemas:core:2.0:User - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User - urn:scim:schemas:extension:cisco:webexidentity:2.0:User userName: user1Changed@example.com userType: user title: Sales manager active: true preferredLanguage: en_US locale: en_US timezone: America/Los_Angeles profileUrl: https://jojowiki.com/Jonathan_Joestar externalId: externalIdNewValue displayName: Mr. Jonathan Jane Joestar, III nickName: JoJo roles: - value: id_full_admin type: cirole display: Full administrator phoneNumbers: - value: 400 123 1234 type: work display: work phone number primary: true photos: - value: https://photos.example.com/profilephoto/72930000000Ccne/F type: photo display: photo description primary: true addresses: - type: work streetAddress: 100 Universal City Plaza locality: Hollywood region: CA postalCode: '91608' country: US emails: - value: user1@example.home.com type: home display: home email description primary: false urn:ietf:params:scim:schemas:extension:enterprise:2.0:User: costCenter: costCenter 123 organization: Cisco webexidentity division: division 456 department: department 789 employeeNumber: 518-8888-888 manager: value: b5717a4a-0169-43b2-ac3c-db20ba4e72cd urn:scim:schemas:extension:cisco:webexidentity:2.0:User: accountStatus: active sipAddresses: - value: sipAddress value1 type: enterprise display: sipAddress1 description primary: true managedOrgs: - orgId: 75fe2995-24f5-4831-8d2c-1c2f8255912e role: id_full_admin managedGroups: - orgId: 0ae87ade-8c8a-4952-af08-318798958d0c groupId: 3936af3e-15ff-43d1-9ef5-66c569ef34f5 role: location_admin extensionAttribute*: [] externalAttribute*: - source: Source.1_7ddf1f2c-2985-4c37-a450-d58bbc201750 value: externalAttribute1_value schema: $ref: '#/components/schemas/PutUser' patch: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetUserResponse' example: schemas: - urn:ietf:params:scim:schemas:core:2.0:User - urn:scim:schemas:extension:cisco:webexidentity:2.0:User - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User id: 3426a8e3-d414-4bf0-a493-4f6787632a13 userName: user1Changed@example.com active: true roles: - value: id_full_admin type: cirole display: Full administrator name: familyName: Joestar givenName: Jonathan middleName: Jane honorificPrefix: Mr. honorificSuffix: III displayName: new displayName value nickName: JoJo emails: - value: user1@example.home.com type: home display: home email description - value: user1Changed@example.com type: work primary: true userType: user profileUrl: https://jojowiki.com/Jonathan_Joestar title: Sales manager preferredLanguage: en_US locale: en_US externalId: externalIdNewValue timezone: America/Los_Angeles phoneNumbers: - value: 400 123 1234 type: work primary: true display: work phone number photos: - value: https://photos.example.com/profilephoto/72930000000Ccne/F type: photo primary: true display: photo description addresses: - type: work streetAddress: 100 Universal City Plaza locality: Hollywood region: CA postalCode: '91608' country: US urn:ietf:params:scim:schemas:extension:enterprise:2.0:User: employeeNumber: 518-8888-888 costCenter: costCenter 123 organization: Cisco webexidentity division: division 456 department: department 789 manager: value: b5717a4a-0169-43b2-ac3c-db20ba4e72cd displayName: Identity Administrator example: https://integration.webexapis.com/identity/scim/0ae87ade-8c8a-4952-af08-318798958d0c/v2/Users/b5717a4a-0169-43b2-ac3c-db20ba4e72cd urn:scim:schemas:extension:cisco:webexidentity:2.0:User: accountStatus: - active sipAddresses: - value: sipAddress value1 type: enterprise primary: true display: sipAddress1 description managedOrgs: - orgId: 75fe2995-24f5-4831-8d2c-1c2f8255912e role: id_full_admin managedGroups: - orgId: 75fe2995-24f5-4831-8d2c-1c2f8255912e groupId: d178e396-aa06-42cd-ab98-5124eb3b1926 role: id_full_admin externalAttribute1: - source: Source.1_7ddf1f2c-2985-4c37-a450-d58bbc201750 value: externalAttribute1_value externalAttribute2: - source: Source.2_7ddf1f2c-2985-4c37-a450-d58bbc201750 value: externalAttribute2_value extensionAttribute1: - extensionAttribute1_Item1 - extensionAttribute1_Item2 extensionAttribute2: - extensionAttribute2_Item1 - extensionAttribute2_Item2 - extensionAttribute2_Item3 meta: organizationId: 0ae87ade-8c8a-4952-af08-318798958d0c meta: resourceType: User location: http://integration.webexapis.com/identity/scim/0ae87ade-8c8a-4952-af08-318798958d0c/v2/Users/3426a8e3-d414-4bf0-a493-4f6787632a13 version: W/"88678579986" created: '2023-01-11T17:38:31.605Z' lastModified: '2023-02-02T11:38:31.009Z' '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 user with PATCH operationId: Update a user with PATCH description: "
\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 the user's object to be modified.\n\n2. Each operation against an attribute must be compatible with the attribute's mutability.\n\n3. 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 adds a new attribute value to an existing resource.\nThe operation must contain a `value` member whose content specifies the value to be added.\nThe 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`.\nThe result of the add operation depends upon the target `path` reference locations:\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`.\nThe 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 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 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 return failure as 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.\n\n The following roles cannot be assigned to a user:\n\n1. Location Admin\n\n2. Webex Site Admin" tags: - SCIM 2 Users parameters: - name: orgId in: path description: Webex Identity assigned organization identifier for user's organization. required: true example: 0ae87ade-8c8a-4952-af08-318798958d0c schema: type: string - name: userId in: path description: Webex Identity assigned user identifier. required: true example: 3426a8e3-d414-4bf0-a493-4f6787632a13 schema: type: string requestBody: content: application/json: example: schemas: - urn:ietf:params:scim:api:messages:2.0:PatchOp Operations: - op: add path: roles value: - value: id_user_admin type: cirole display: Full Administrator. schema: $ref: '#/components/schemas/PatchUser' 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 user operationId: Delete a user description: '
**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_user_admin`
' tags: - SCIM 2 Users parameters: - name: orgId in: path description: Webex Identity assigned organization identifier for user's organization. required: true example: 0ae87ade-8c8a-4952-af08-318798958d0c schema: type: string - name: userId in: path description: Webex Identity assigned user identifier. required: true example: 3426a8e3-d414-4bf0-a493-4f6787632a13 schema: type: string /identity/scim/v2/Users/me: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/GetUserResponse' '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 Me operationId: Get Me description: '
**Authorization** OAuth token rendered by Identity Broker.
One of the following OAuth scopes is required: - `identity:people_rw` - `identity:people_read`
The API can be used by any user to retrieve user information using their own access token.
' tags: - SCIM 2 Users parameters: [] components: schemas: ManagedGroupsObject: type: object required: - orgId - groupId - role properties: orgId: type: string example: 0ae87ade-8c8a-4952-af08-318798958d0c description: Webex Identity assigned organization identifier. groupId: type: string example: 3936af3e-15ff-43d1-9ef5-66c569ef34f5 description: Webex Identity assigned group identifier. role: type: string example: location_admin description: Role in the target group for the user. SipAddressObject: type: object required: - value properties: value: type: string example: sipAddress value1 description: The `sipAddress` value. type: type: string enum: - enterprise description: '`sipAddress` type.' display: type: string example: sipAddress1 description description: A human-readable description, primarily used for display purposes. primary: type: boolean example: true description: Designate the primary `sipAddress`. SearchGetUserResponse: type: object required: - schemas - id - userName - userType - meta properties: schemas: type: array items: type: string example: urn:ietf:params:scim:schemas:core:2.0:User,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,urn:scim:schemas:extension:cisco:webexidentity:2.0:User description: Input JSON schemas. id: type: string example: 3426a8e3-d414-4bf0-a493-4f6787632a13 description: Webex Identity assigned user identifier. userName: type: string example: user1@example.com description: A unique identifier for the user and authenticates the user in Webex. This must be set to the user's primary email address. No other user in Webex may have the same `userName` value and thus is required to be unique within Webex. active: type: boolean example: true description: A boolean value of "true" or "false" indicating whether the user is allowed to login in Webex. roles: type: array items: $ref: '#/components/schemas/RoleObject' description: List of roles assigned to the user. name: $ref: '#/components/schemas/NameObject' description: The components of the user's real name. displayName: type: string example: Mr. Jonathan Jane Joestar, III description: The name displayed for the user in Webex. nickName: type: string example: JoJo description: A casual name of the user. For example, Bob when the user's formal name is Robert. emails: type: array items: $ref: '#/components/schemas/EmailObject' description: A list of the user's email addresses, including primary and alternative emails. The primary work email address must match the value of the user's username. userType: $ref: '#/components/schemas/UserTypeObject' description: User type. profileUrl: type: string example: https://jojowiki.com/Jonathan_Joestar description: A fully qualified URL pointing to a page representing the user's online profile. title: type: string example: Sales manager description: The user's business title. Examples of a title is "Business Manager". "Senior Accountant", "Engineer" etc. preferredLanguage: type: string example: en_US description: "User's preferred language. Acceptable values are based on the [ISO-696](http://www.loc.gov/standards/iso639-2/php/code_list.php) and [ISO-3166](https://www.iso.org/obp/ui/#search) with the 2 letter language code followed by an _ and then the 2 letter country code. Examples are:\n\n en_US : for United States English or fr_FR for Parisian French." locale: type: string example: en_US description: "The user's locale which represents the user's currency, time format, and numerical representations. Acceptable values are based on the [ISO-696](http://www.loc.gov/standards/iso639-2/php/code_list.php) and [ISO-3166](https://www.iso.org/obp/ui/#search) with the 2 letter language code followed by an _ and then the 2 letter country code. Examples are:\n\n en_US : for United States English or fr_FR for Parisian French." externalId: type: string example: externalIdValue description: User identifier provided by an external provisioning source. timezone: type: string example: America/Los_Angeles description: The user's time zone specified in the [IANA timezone](https://nodatime.org/timezones) timezone format, for example, "America/Los_Angeles". phoneNumbers: type: array items: $ref: '#/components/schemas/PhoneNumberObject' description: A list of user's phone numbers. groups: type: array items: $ref: '#/components/schemas/GroupObject' description: A list of group details returned only when `includeGroupDetails` or `returnGroups` request parameters are set to true. photos: type: array items: $ref: '#/components/schemas/PhotoObject' description: A list of photo objects for the user. addresses: type: array items: $ref: '#/components/schemas/AddressObject' description: User's physical mailing address. urn:ietf:params:scim:schemas:extension:enterprise:2.0:User: type: object properties: costCenter: type: string example: costCenter 123 description: Name of a cost center. organization: type: string example: Cisco webexidentity description: Name of an organization. division: type: string example: division 456 description: Name of a division. department: type: string example: department 789 description: Name of a department. employeeNumber: type: string example: 518-8888-888 description: Numeric or alphanumeric identifier assigned to a person, typically based on the order of hire or association with an organization. manager: $ref: '#/components/schemas/ManagerResponseObject' description: The user's manager. description: SCIM2 enterprise extension urn:scim:schemas:extension:cisco:webexidentity:2.0:User: type: object required: - accountStatus properties: accountStatus: $ref: '#/components/schemas/AccountStatusObject' description: An array of additional information about a user's status. sipAddresses: type: array items: $ref: '#/components/schemas/SipAddressObject' description: '`sipAddress` values for the user.' managedOrgs: type: array items: $ref: '#/components/schemas/ManagedOrgsObject' description: Organizations that the user can manage. managedGroups: type: array items: $ref: '#/components/schemas/ManagedGroupsObject' description: Groups that the user can manage. extensionAttribute*: type: array items: type: string description: 'The extension attributes of the user. Postfix support from 1 to 15, for example: "extensionAttribute1", "extensionAttribute2", ..., "extensionAttribute15".' externalAttribute*: type: array items: $ref: '#/components/schemas/ExternalAttributeObject' description: 'The external attributes of the user. Postfix support from 1 to 15, for example: "externalAttribute1", "externalAttribute2", ..., "externalAttribute15".' description: The Cisco extension of SCIM 2. meta: $ref: '#/components/schemas/MetaObject' description: Response metadata. GroupObject: type: object properties: value: type: string example: 11d0ec88-04b9-4ece-9f28-06e1d7673ee3 description: A unique identifier for the group. display: type: string example: Darmstadt description: Display name of the group. $ref: type: string example: https://webexapis.com/identity/scim/36818b6f-ef07-43d1-b76f-ced79ab2e3e7/v2/Groups/11d0ec88-04b9-4ece-9f28-06e1d7673ee3 description: The URI corresponding to a group. PutUser: type: object required: - schemas - userName - userType properties: schemas: type: array items: type: string example: urn:ietf:params:scim:schemas:core:2.0:User,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,urn:scim:schemas:extension:cisco:webexidentity:2.0:User description: Input JSON schemas. userName: type: string example: user1Changed@example.com description: A unique identifier for the user and authenticates the user in Webex. This must be set to the user's primary email address. No other user in Webex may have the same `userName` value and thus this value is required to be unique within Webex. userType: $ref: '#/components/schemas/UserTypeObject' description: User type. title: type: string example: Sales manager description: The user's business title. Examples of a title is "Business Manager". "Senior Accountant", "Engineer" etc. active: type: boolean example: true description: A boolean value of "true" or "false" indicating whether the user is allowed to login to Webex. roles: type: array items: $ref: '#/components/schemas/RoleObject' description: List of roles assigned to the user. preferredLanguage: type: string example: en_US description: "User's preferred language. Acceptable values for this field are based on the [ISO-696](http://www.loc.gov/standards/iso639-2/php/code_list.php) and [ISO-3166](https://www.iso.org/obp/ui/#search) with the 2 letter language code followed by an _ and then the 2 letter country code. Examples are:\n\n en_US : for United States English or fr_FR for Parisian French." locale: type: string example: en_US description: "The user's locale which represents the user's currency, time format, and numerical representations. Acceptable values are based on the [ISO-696](http://www.loc.gov/standards/iso639-2/php/code_list.php) and [ISO-3166](https://www.iso.org/obp/ui/#search) with the 2 letter language code followed by an _ and then the 2 letter country code. Examples are:\n\n en_US : for United States English or fr_FR for Parisian French." timezone: type: string example: America/Los_Angeles description: 'The user''s time zone specified in the [IANA timezone](https://nodatime.org/timezones) timezone format. e.g: "America/Los_Angeles".' profileUrl: type: string example: https://jojowiki.com/Jonathan_Joestar description: A fully qualified URL pointing to a page representing the user's online profile. externalId: type: string example: externalIdNewValue description: User identifier provided by an external provisioning source. displayName: type: string example: Mr. Jonathan Jane Joestar, III description: The name displayed for the user in Webex. nickName: type: string example: JoJo description: A casual name of the user. For example, Bob when the user's formal name is Robert. phoneNumbers: type: array items: type: object properties: value: type: string example: 400 123 1234 description: phone number. type: type: string enum: - work - home - mobile - work_extension - fax - pager - other description: 'We support the following phone number types: ''mobile'', ''work'', ''fax'', ''work_extension'', ''alternate1'', ''alternate2''. Alternate 1 and Alternate 2 are types inherited from Webex meeting sites.' display: type: string example: work phone number description: A human-readable name, primarily used for display purposes. primary: type: boolean example: true description: A Boolean value indicating the phone number's primary status. description: A list of user's phone numbers. photos: type: array items: $ref: '#/components/schemas/PhotoObject' description: A list of photo objects for the user. addresses: type: array items: type: object properties: type: type: string example: work description: address type streetAddress: type: string example: 100 Universal City Plaza description: The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information. This attribute MAY contain newlines. locality: type: string example: Hollywood description: The city or locality component. region: type: string example: CA description: The state or region component. postalCode: type: string example: '91608' description: The zip code or postal code component. country: type: string example: US description: The country name component. description: User's physical mailing address. emails: type: array items: $ref: '#/components/schemas/EmailObject' description: A list of the user's email addresses, including primary and alternative emails. The primary work email address must match the value of the user's username. urn:ietf:params:scim:schemas:extension:enterprise:2.0:User: type: object properties: costCenter: type: string example: costCenter 123 description: Name of a cost center. organization: type: string example: Cisco webexidentity description: Name of an organization. division: type: string example: division 456 description: Name of a division. department: type: string example: department 789 description: Name of a department. employeeNumber: type: string example: 518-8888-888 description: Numeric or alphanumeric identifier assigned to a person, typically based on the order of hire or association with an organization. manager: type: object required: - value properties: value: type: string example: b5717a4a-0169-43b2-ac3c-db20ba4e72cd description: Webex Identity assigned user identifier of the user's manager. The manager must belong to the same org as the user. description: The user's manager. description: SCIM2 enterprise extension urn:scim:schemas:extension:cisco:webexidentity:2.0:User: type: object required: - accountStatus properties: accountStatus: $ref: '#/components/schemas/AccountStatusObject' description: An array of additional information about a user's status. sipAddresses: type: array items: $ref: '#/components/schemas/SipAddressObject' description: '`sipAddress` values for the user.' managedOrgs: type: array items: $ref: '#/components/schemas/ManagedOrgsObject' description: Organizations that the user can manage. managedGroups: type: array items: $ref: '#/components/schemas/ManagedGroupsObject' description: Groups that the user can manage. extensionAttribute*: type: array items: type: string description: 'The extension attributes of the user. Postfix support from 1 to 15, for example: "extensionAttribute1", "extensionAttribute2", ..., "extensionAttribute15".' externalAttribute*: type: array items: $ref: '#/components/schemas/ExternalAttributeObject' description: 'The external attributes of the user. Postfix support from 1 to 15, for example: "externalAttribute1", "externalAttribute2", ..., "externalAttribute15".' description: cisco extension of SCIM 2 AccountStatusObject: type: string description: An array of additional information about a user's status. enum: - active - pending - transient - disabled - fraud - fraud_transient - compliance_transient - pending_transient GetUserResponse: type: object required: - schemas - id - userName - userType - meta properties: schemas: type: array items: type: string example: urn:ietf:params:scim:schemas:core:2.0:User,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,urn:scim:schemas:extension:cisco:webexidentity:2.0:User description: Input JSON schemas. id: type: string example: 3426a8e3-d414-4bf0-a493-4f6787632a13 description: Webex Identity assigned user identifier. userName: type: string example: user1@example.com description: A unique identifier for the user and authenticates the user in Webex. This must be set to the user's primary email address. No other user in Webex may have the same `userName` value and thus this value is required to be unique within Webex. active: type: boolean example: true description: A boolean value of "true" or "false" indicating whether the user is allowed to login in Webex. roles: type: array items: $ref: '#/components/schemas/RoleObject' description: List of roles assigned to the user. name: $ref: '#/components/schemas/NameObject' description: The components of the user's real name. displayName: type: string example: Mr. Jonathan Jane Joestar, III description: The name displayed for the user in Webex. nickName: type: string example: JoJo description: A casual name of the user. For example, Bob when the user's formal name is Robert. emails: type: array items: $ref: '#/components/schemas/EmailObject' description: A list of the user's email addresses, including primary and alternative emails. The primary work email address must match the value of the user's username. userType: $ref: '#/components/schemas/UserTypeObject' description: User type. profileUrl: type: string example: https://jojowiki.com/Jonathan_Joestar description: A fully qualified URL pointing to a page representing the user's online profile. title: type: string example: Sales manager description: The user's business title. Examples of a title is "Business Manager". "Senior Accountant", "Engineer" etc. preferredLanguage: type: string example: en_US description: "User's preferred language. Acceptable values for this field are based on the [ISO-696](http://www.loc.gov/standards/iso639-2/php/code_list.php) and [ISO-3166](https://www.iso.org/obp/ui/#search) with the 2 letter language code followed by an _ and then the 2 letter country code. Examples are:\n\n en_US : for United States English or fr_FR for Parisian French." locale: type: string example: en_US description: "The user's locale which represents the user's currency, time format, and numerical representations. Acceptable values for this field are based on the [ISO-696](http://www.loc.gov/standards/iso639-2/php/code_list.php) and [ISO-3166](https://www.iso.org/obp/ui/#search) with the 2 letter language code followed by an _ and then the 2 letter country code. Examples are:\n\n en_US : for United States English or fr_FR for Parisian French." externalId: type: string example: externalIdValue description: User identifier provided by an external provisioning source. timezone: type: string example: America/Los_Angeles description: The user's time zone specified in the [IANA timezone](https://nodatime.org/timezones) timezone format, for example, "America/Los_Angeles". phoneNumbers: type: array items: $ref: '#/components/schemas/PhoneNumberObject' description: A list of user's phone numbers. photos: type: array items: $ref: '#/components/schemas/PhotoObject' description: A list of photo objects for the user. addresses: type: array items: $ref: '#/components/schemas/AddressObject' description: User's physical mailing address. urn:ietf:params:scim:schemas:extension:enterprise:2.0:User: type: object properties: costCenter: type: string example: costCenter 123 description: Name of a cost center. organization: type: string example: Cisco webexidentity description: Name of an organization. division: type: string example: division 456 description: Name of a division. department: type: string example: department 789 description: Name of a department. employeeNumber: type: string example: 518-8888-888 description: Numeric or alphanumeric identifier assigned to a person, typically based on the order of hire or association with an organization. manager: $ref: '#/components/schemas/ManagerResponseObject' description: The user's manager. description: SCIM2 enterprise extension urn:scim:schemas:extension:cisco:webexidentity:2.0:User: type: object required: - accountStatus properties: accountStatus: $ref: '#/components/schemas/AccountStatusObject' description: An array of additional information about a user's status. sipAddresses: type: array items: $ref: '#/components/schemas/SipAddressObject' description: '`sipAddress` values for the user.' managedOrgs: type: array items: $ref: '#/components/schemas/ManagedOrgsObject' description: Organizations that the user can manage. managedGroups: type: array items: $ref: '#/components/schemas/ManagedGroupsObject' description: Groups that the user can manage. extensionAttribute*: type: array items: type: string description: 'The extension attributes of the user. Postfix support from 1 to 15, for example: "extensionAttribute1", "extensionAttribute2", ..., "extensionAttribute15".' externalAttribute*: type: array items: $ref: '#/components/schemas/ExternalAttributeObject' description: 'The external attributes of the user. Postfix support from 1 to 15, for example: "externalAttribute1", "externalAttribute2", ..., "externalAttribute15".' description: The Cisco extension of SCIM 2. meta: $ref: '#/components/schemas/MetaObject' description: Response metadata. 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. AddressObject: type: object properties: type: type: string example: work description: The type of the address. streetAddress: type: string example: 100 Universal City Plaza description: The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information. This attribute MAY contain newlines. locality: type: string example: Hollywood description: The city or locality component. region: type: string example: CA description: The state or region component. postalCode: type: string example: '91608' description: The zip code or postal code component. country: type: string example: US description: The country name component. PostUser: type: object required: - schemas - userName - userType properties: schemas: type: array items: type: string example: urn:ietf:params:scim:schemas:core:2.0:User,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User,urn:scim:schemas:extension:cisco:webexidentity:2.0:User description: Input JSON schemas. userName: type: string example: user1@example.com description: A unique identifier for the user that authenticates the user in Webex. This must be set to the user's primary email address. No other user in Webex may have the same `userName` value, so this value must be unique within Webex. userType: $ref: '#/components/schemas/UserTypeObject' description: User type. title: type: string example: Sales manager description: The user's business title. Examples of a title is "Business Manager". "Senior Accountant", "Engineer" etc. active: type: boolean example: true description: A boolean value of "true" or "false" indicating whether the user is allowed to login to Webex. roles: type: array items: $ref: '#/components/schemas/RoleObject' description: List of roles assigned to the user. preferredLanguage: type: string example: en_US description: "User's preferred language. Acceptable values are based on the [ISO-696](http://www.loc.gov/standards/iso639-2/php/code_list.php) and [ISO-3166](https://www.iso.org/obp/ui/#search) with the 2 letter language code followed by an _ and then the 2 letter country code. Examples are:\n\n en_US : for United States English or fr_FR for Parisian French." locale: type: string example: en_US description: "The user's locale which represents the user's currency, time format, and numerical representations. Acceptable values are based on the [ISO-696](http://www.loc.gov/standards/iso639-2/php/code_list.php) and [ISO-3166](https://www.iso.org/obp/ui/#search) with the 2 letter language code followed by an _ and then the 2 letter country code. Examples are:\n\n en_US : for United States English or fr_FR for Parisian French." timezone: type: string example: America/Los_Angeles description: The user's time zone specified in the [IANA timezone](https://nodatime.org/timezones) timezone format, for example, "America/Los_Angeles". profileUrl: type: string example: https://jojowiki.com/Jonathan_Joestar description: A fully qualified URL pointing to a page representing the user's online profile. externalId: type: string example: externalIdValue description: User identifier provided by an external provisioning source. displayName: type: string example: Mr. Jonathan Jane Joestar, III description: The name displayed for the user in Webex. nickName: type: string example: JoJo description: A casual name of the user. For example, Bob when the user's formal name is Robert. name: $ref: '#/components/schemas/NameObject' description: The components of the user's real name. phoneNumbers: type: array items: $ref: '#/components/schemas/PhoneNumberObject' description: A list of user's phone numbers. photos: type: array items: $ref: '#/components/schemas/PhotoObject' description: A list of photo objects for the user. addresses: type: array items: $ref: '#/components/schemas/AddressObject' description: User's physical mailing address. emails: type: array items: $ref: '#/components/schemas/EmailObject' description: A list of the user's email addresses, including primary and alternative emails. The primary work email address must match the value of the user's username. urn:ietf:params:scim:schemas:extension:enterprise:2.0:User: type: object properties: costCenter: type: string example: costCenter 123 description: Name of a cost center. organization: type: string example: Cisco webexidentity description: Name of an organization. division: type: string example: division 456 description: Name of a division. department: type: string example: department 789 description: Name of a department. employeeNumber: type: string example: 518-8888-888 description: Numeric or alphanumeric identifier assigned to a person, typically based on the order of hire or association with an organization. manager: type: object required: - value properties: value: type: string example: b5717a4a-0169-43b2-ac3c-db20ba4e72cd description: Webex Identity assigned user identifier of the user's manager. The manager must belong to the same org as the user. description: The user's manager. description: SCIM2 enterprise extension urn:scim:schemas:extension:cisco:webexidentity:2.0:User: type: object required: - accountStatus properties: accountStatus: $ref: '#/components/schemas/AccountStatusObject' description: An array of additional information about a user's status. sipAddresses: type: array items: $ref: '#/components/schemas/SipAddressObject' description: '`sipAddress` values for the user.' managedOrgs: type: array items: $ref: '#/components/schemas/ManagedOrgsObject' description: Organizations that the user can manage. managedGroups: type: array items: $ref: '#/components/schemas/ManagedGroupsObject' description: Groups that the user can manage. extensionAttribute*: type: array items: type: string description: 'The extension attributes of the user. Postfix support from 1 to 15, for example: "extensionAttribute1", "extensionAttribute2", ..., "extensionAttribute15".' externalAttribute*: type: array items: $ref: '#/components/schemas/ExternalAttributeObject' description: 'The external attributes of the user. Postfix support from 1 to 15, for example: "externalAttribute1", "externalAttribute2", ..., "externalAttribute15".' description: The Cisco extension of SCIM 2. SearchUserResponse: type: object required: - schemas properties: schemas: type: array items: type: string example: urn:ietf:params:scim:api:messages:2.0:ListResponse description: Input JSON schemas. totalResults: type: number example: 2 description: Total number of users 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 users. Resources: type: array items: $ref: '#/components/schemas/SearchGetUserResponse' description: A list of users with details. PhotoObject: type: object properties: value: type: string example: https://photos.example.com/profilephoto/72930000000Ccne/F description: photo link. type: type: string enum: - photo - thumbnail - resizable description: The type of the photo display: type: string example: photo description description: A human-readable description, primarily used for display purposes. primary: type: boolean example: true description: A Boolean value for the photo usage status. UserTypeObject: type: string enum: - user - room - external_calling - calling_service NameObject: type: object description: The components of the user's real name. properties: givenName: type: string example: Sarah description: The given name of the user, or first name in most Western languages (e.g., "Sarah" given the full name "Ms. Sarah J Henderson, III"). familyName: type: string example: Henderson description: The family name of the user, or last name in most Western languages (e.g., "Henderson" given the full name "Ms. Sarah J Henderson, III"). middleName: type: string example: Jane description: The middle name(s) of the user (e.g., "Jane" given the full name "Ms. Sarah J Henderson, III"). honorificPrefix: type: string example: Mr. description: The honorific prefix(es) of the user, or title in most Western languages (e.g., "Ms." given the full name "Ms. Sarah J Henderson, III"). honorificSuffix: type: string example: III description: The honorific suffix(es) of the user, or suffix in most Western languages (e.g., "III" given the full name "Ms. Sarah J Henderson, III"). ManagedOrgsObject: type: object required: - orgId - role properties: orgId: type: string example: 75fe2995-24f5-4831-8d2c-1c2f8255912e description: Webex Identity assigned organization identifier. role: type: string example: id_full_admin description: Role in the target organization for the user. ManagerResponseObject: type: object description: The user's manager. required: - value properties: value: type: string example: b5717a4a-0169-43b2-ac3c-db20ba4e72cd description: Webex Identity assigned user identifier of the user's manager. The manager must belong to the same org as the user. displayName: type: string example: Identity Administrator description: The name displayed for the manager in Webex. $ref: type: string example: https://integration.webexapis.com/identity/scim/0ae87ade-8c8a-4952-af08-318798958d0c/v2/Users/b5717a4a-0169-43b2-ac3c-db20ba4e72cd description: The URI corresponding to a SCIM user that is the manager. PatchUser: 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/RoleObject' description: New value. description: A list of patch operations. ExternalAttributeObject: type: object required: - source - value properties: source: type: string example: Source.1_7ddf1f2c-2985-4c37-a450-d58bbc201750 description: Source of external attribute. value: type: string example: externalAttribute1_value description: Value of external attribute. EmailObject: type: object properties: value: type: string example: user1@example.home.com description: The email address. type: type: string enum: - work - home - room - other description: The type of the email. display: type: string example: home email description description: A human-readable description, primarily used for display purposes. primary: type: boolean description: Email status boolean value. If the type is work and primary is true, the value must equal `userName`. RoleObject: type: object properties: value: type: string example: id_full_admin description: CI Role type: type: string example: cirole description: name display: type: string example: Full Administrator description: A human-readable name, primarily used for display purposes. PhoneNumberObject: type: object properties: value: type: string example: 400 123 1234 description: phone number. type: type: string enum: - work - home - mobile - work_extension - fax - pager - other description: 'We support the following phone number types: ''mobile'', ''work'', ''fax'', ''work_extension'', ''alternate1'', ''alternate2''. Alternate 1 and Alternate 2 are types inherited from Webex meeting sites.' display: type: string example: work phone number description: A human-readable name, primarily used for display purposes. primary: type: boolean example: true description: A Boolean value for phone number's primary status. 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