openapi: 3.0.0 info: title: Webex Admin Address Book 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: Users paths: /organization/{orgid}/user: get: tags: - Users summary: List User(s) description: Retrieve a list of User(s) in a given organization. operationId: getAllConfig_16 parameters: - name: orgid in: path description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1 - name: filter in: query description: "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n" required: false schema: type: string example: id=="2f9eecc5-0472-4549-9a83-2afdae0d4ba1" - name: attributes in: query description: Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. required: false schema: type: string format: string example: id - name: page in: query description: Defines the number of displayed page. The page number starts from 0. schema: type: integer default: 0 example: 0 example: 0 - name: pageSize in: query description: Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size. schema: type: integer default: 100 example: 100 example: 100 - name: singleObjectResponse in: query description: Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception. schema: type: boolean default: false example: false responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/UserResponseDTO' example: - imiUserCreated: false lastName: Wick userLevelSummariesInclusion: INCLUDED timezone: America/New_York preferredSupervisorTeamId: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1 organizationId: f53c8b54-46ca-43f6-ba05-08426a46e23d broadCloudUserId: 1dq21e23-1234-5578-9a83-2afdae0d4ba1 externalIdentifier: '121212' createdTime: 1679393400000 lastUpdatedTime: 1679393400000 id: 93912f11-6017-404b-bf14-5331890b1797 contactCenterEnabled: true email: johnwick@company.com ciUserId: 1dq21e23-1234-5578-9a83-2afdae0d4ba1 xspVersion: xsp-24.0 userLevelAutoCSATInclusion: INCLUDED mobile: '1234567890' active: true version: 1 skillProfileId: f53c8b54-46ca-43f6-ba05-08426a46e23d firstName: John userLevelWellnessBreakReminders: DISABLED agentProfileId: 8e6bb6da-2a78-4768-bef9-7e229f92af22 siteId: 8e6bb6da-2a78-4768-bef9-7e229f92af22 userLevelBurnoutInclusion: INCLUDED workPhone: '1234567890' userProfileId: 1dq21e23-1234-5578-9a83-2afdae0d4ba1 multimediaProfileId: f53c8b54-46ca-43f6-ba05-08426a46e23d subscriptionId: 04d0bdf6-6d6a-4aae-8a8a-71c9152e6478 deafultDialledNumber: '1234567890' application/hal+json: schema: type: array items: $ref: '#/components/schemas/UserResponseDTO' example: - imiUserCreated: false lastName: Wick userLevelSummariesInclusion: INCLUDED timezone: America/New_York preferredSupervisorTeamId: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1 organizationId: f53c8b54-46ca-43f6-ba05-08426a46e23d broadCloudUserId: 1dq21e23-1234-5578-9a83-2afdae0d4ba1 externalIdentifier: '121212' createdTime: 1679393400000 lastUpdatedTime: 1679393400000 id: 93912f11-6017-404b-bf14-5331890b1797 contactCenterEnabled: true email: johnwick@company.com ciUserId: 1dq21e23-1234-5578-9a83-2afdae0d4ba1 xspVersion: xsp-24.0 userLevelAutoCSATInclusion: INCLUDED mobile: '1234567890' active: true version: 1 skillProfileId: f53c8b54-46ca-43f6-ba05-08426a46e23d firstName: John userLevelWellnessBreakReminders: DISABLED agentProfileId: 8e6bb6da-2a78-4768-bef9-7e229f92af22 siteId: 8e6bb6da-2a78-4768-bef9-7e229f92af22 userLevelBurnoutInclusion: INCLUDED workPhone: '1234567890' userProfileId: 1dq21e23-1234-5578-9a83-2afdae0d4ba1 multimediaProfileId: f53c8b54-46ca-43f6-ba05-08426a46e23d subscriptionId: 04d0bdf6-6d6a-4aae-8a8a-71c9152e6478 deafultDialledNumber: '1234567890' '401': description: Unauthorized Operation content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '401' reason: Test reason message: - description: Test error code: '401' entity: cc_user references: [] '403': description: Operation is forbidden content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '403' reason: Test reason message: - description: Test error code: '403' entity: cc_user references: [] '404': description: Resource not found or URI is invalid content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '404' reason: Test reason message: - description: Test error code: '404' entity: cc_user references: [] '429': description: Too many requests have been sent in a given amount of time and the request has been rate limited content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '429' reason: Test reason message: - description: Test error code: '429' entity: cc_user references: [] '500': description: An Unexpected Error Occurred content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '500' reason: Test reason message: - description: Test error code: '500' entity: cc_user references: [] deprecated: true /organization/{orgid}/user/bulk: patch: tags: - Users summary: Bulk partial update Users description: Update some or all properties for multiple users in bulk for a given organization. operationId: patchAllConfig parameters: - name: orgid in: path description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1 requestBody: description: 'For each of the item to update, We only need to provide the patch JSON. Only the following properties are mandatory to identify unique item for update. Other properties are optional. Mandatory Properties: [id] All properties that can be updated via PUT Api are allowed to be updated. To nullify a property or remove it, specify null as value for the Json property. Valid value for requestAction property is ''SAVE''. It is optional property and default SAVE is assumed. ' content: application/json: schema: $ref: '#/components/schemas/BulkRequestDTOUserDTO' example: items: - item: id: 26e2df70-0f77-41b8-8e8f-1d76e92c9638 firstName: John14 lastName: Wick14 userLevelBurnoutInclusion: INCLUDED itemIdentifier: 0 requestAction: SAVE required: true responses: '207': description: Multi-Status content: application/hal+json: schema: $ref: '#/components/schemas/BulkResponseDTO' application/json: schema: $ref: '#/components/schemas/BulkResponseDTO' '400': description: The request was invalid and cannot be served. An accompanying error message will explain further content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '400' reason: Test reason message: - description: Test error code: '400' entity: cc_user references: [] '401': description: Unauthorized Operation content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '401' reason: Test reason message: - description: Test error code: '401' entity: cc_user references: [] '403': description: Operation is forbidden content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '403' reason: Test reason message: - description: Test error code: '403' entity: cc_user references: [] '404': description: Resource not found or URI is invalid content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '404' reason: Test reason message: - description: Test error code: '404' entity: cc_user references: [] '429': description: Too many requests have been sent in a given amount of time and the request has been rate limited content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '429' reason: Test reason message: - description: Test error code: '429' entity: cc_user references: [] '500': description: An Unexpected Error Occurred content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '500' reason: Test reason message: - description: Test error code: '500' entity: cc_user references: [] /organization/{orgid}/user/bulk/update-dynamic-skill/{skillId}: patch: tags: - Users summary: Bulk update User dynamic skills description: Assign or unassign a dynamic skill to/from multiple users in bulk for a given organization. operationId: patchDynamicSkills parameters: - name: orgid in: path description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1 - name: skillId in: path required: true schema: type: string description: The unique identifier of the skill. requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkRequestDTOUpdateDynamicSkillsDTO' required: true responses: '207': description: Multi-Status content: application/hal+json: schema: $ref: '#/components/schemas/BulkResponseDTO' application/json: schema: $ref: '#/components/schemas/BulkResponseDTO' '400': description: The request was invalid and cannot be served. An accompanying error message will explain further content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '400' reason: Test reason message: - description: Test error code: '400' entity: cc_user references: [] '401': description: Unauthorized Operation content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '401' reason: Test reason message: - description: Test error code: '401' entity: cc_user references: [] '403': description: Operation is forbidden content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '403' reason: Test reason message: - description: Test error code: '403' entity: cc_user references: [] '404': description: Resource not found or URI is invalid content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '404' reason: Test reason message: - description: Test error code: '404' entity: cc_user references: [] '429': description: Too many requests have been sent in a given amount of time and the request has been rate limited content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '429' reason: Test reason message: - description: Test error code: '429' entity: cc_user references: [] '500': description: An Unexpected Error Occurred content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '500' reason: Test reason message: - description: Test error code: '500' entity: cc_user references: [] /organization/{orgid}/user/by-ci-user-id/{id}: get: tags: - Users summary: Get specific User by CI User ID description: Retrieve an existing User using the CI ID in a given organization. operationId: getUserByCiUserId parameters: - name: orgid in: path description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1 - name: id in: path description: CI ID of the User. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2 - name: includeUserProfile in: query description: Specifiy whether to include user profile data required: false schema: type: boolean example: true responses: '200': description: OK content: application/hal+json: schema: $ref: '#/components/schemas/UserResponseDTO_UserResponseWithUserProfile' application/json: schema: $ref: '#/components/schemas/UserResponseDTO_UserResponseWithUserProfile' '401': description: Unauthorized Operation content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '401' reason: Test reason message: - description: Test error code: '401' entity: cc_user references: [] '403': description: Operation is forbidden content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '403' reason: Test reason message: - description: Test error code: '403' entity: cc_user references: [] '404': description: Resource not found or URI is invalid content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '404' reason: Test reason message: - description: Test error code: '404' entity: cc_user references: [] '429': description: Too many requests have been sent in a given amount of time and the request has been rate limited content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '429' reason: Test reason message: - description: Test error code: '429' entity: cc_user references: [] '500': description: An Unexpected Error Occurred content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '500' reason: Test reason message: - description: Test error code: '500' entity: cc_user references: [] /organization/{orgid}/user/by-dynamic-skill-id/{skillId}: get: tags: - Users summary: Get users by dynamic skill ID description: Fetches all users assigned to a specific dynamic skill with search and pagination support. Returns user details with the specific dynamic skill value. operationId: getUsersByDynamicSkillId parameters: - name: orgid in: path description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1 - name: skillId in: path description: The dynamic skill ID to fetch users for required: true schema: type: string example: af9eecc5-0472-4549-9a83-2afdae0d4ba0 - name: search in: query description: 'Filter data based on the search keyword.Supported search columns(firstName, lastName, email, value) The examples below show some search queries - "Cisco" ' required: false schema: type: string example: contact center - name: page in: query description: Defines the number of displayed page. The page number starts from 0. schema: type: integer default: 0 - name: pageSize in: query description: Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size. schema: type: integer default: 100 responses: '200': description: OK content: application/hal+json: schema: $ref: '#/components/schemas/ResponseEnvelopeUserDynamicSkillResponseDTO' application/json: schema: $ref: '#/components/schemas/ResponseEnvelopeUserDynamicSkillResponseDTO' '401': description: Unauthorized Operation content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '401' reason: Test reason message: - description: Test error code: '401' entity: cc_user references: [] '403': description: Operation is forbidden content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '403' reason: Test reason message: - description: Test error code: '403' entity: cc_user references: [] '404': description: Resource not found or URI is invalid content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '404' reason: Test reason message: - description: Test error code: '404' entity: cc_user references: [] '429': description: Too many requests have been sent in a given amount of time and the request has been rate limited content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '429' reason: Test reason message: - description: Test error code: '429' entity: cc_user references: [] '500': description: An Unexpected Error Occurred content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '500' reason: Test reason message: - description: Test error code: '500' entity: cc_user references: [] /organization/{orgid}/user/fetch-by-skill-requirements: post: tags: - Users summary: Get the agents matching skill requirements criteria description: This API can be used to fetch the agents who match the provided skill requirements criteria. Maximum of 50 skill requirements criteria can be passed in the request. operationId: getUsersBySkillRequirements parameters: - name: orgid in: path description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1 - name: search in: query description: 'Filter data based on the search keyword.Supported search columns(firstName, lastName, email) The examples below show some search queries - "Cisco" - field=="firstName";value=="Cisco" - fields=in=("firstName","lastName");value=="Cisco" ' required: false schema: type: string example: contact center - name: page in: query description: Defines the number of displayed page. The page number starts from 0. schema: type: integer default: 0 example: 0 example: 0 - name: pageSize in: query description: Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size. schema: type: integer default: 100 example: 100 example: 100 requestBody: content: application/json: schema: $ref: '#/components/schemas/QueueSkillRequirementDTO' example: skillRequirements: - organizationId: 0271223b-91de-427d-872a-1b3c1bb746b9 id: 5e8cdad5-94da-4ffc-86d7-c904e4490626 skillId: bc5658a9-5aa7-45ec-b960-43dcfc73c34d skillName: skillA skillType: TEXT condition: IS skillValue: abc - condition: IS skillValue: '8' skillName: ProfSkillC skillType: PROFICIENCY skillId: c683cf8d-49e8-4e85-9e08-c8749affa9cc required: true responses: '200': description: OK content: application/hal+json: schema: type: object properties: meta: $ref: '#/components/schemas/MetaDataWithPagingInfo' data: type: array items: $ref: '#/components/schemas/UserWithSkillDetailsDTO' application/json: schema: type: object properties: meta: $ref: '#/components/schemas/MetaDataWithPagingInfo' data: type: array items: $ref: '#/components/schemas/UserWithSkillDetailsDTO' '400': description: The request was invalid and cannot be served. An accompanying error message will explain further content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '400' reason: Test reason message: - description: Test error code: '400' entity: cc_user references: [] '401': description: Unauthorized Operation content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '401' reason: Test reason message: - description: Test error code: '401' entity: cc_user references: [] '403': description: Operation is forbidden content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '403' reason: Test reason message: - description: Test error code: '403' entity: cc_user references: [] '409': description: Similar entity is already present content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '409' reason: Test reason message: - description: Test error code: '409' entity: cc_user references: [] '429': description: Too many requests have been sent in a given amount of time and the request has been rate limited content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '429' reason: Test reason message: - description: Test error code: '429' entity: cc_user references: [] '500': description: An Unexpected Error Occurred content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '500' reason: Test reason message: - description: Test error code: '500' entity: cc_user references: [] /organization/{orgid}/user/fetch-user-details-by-ids: post: tags: - Users summary: Fetch User details by IDs description: Retrieve an existing User's first name, last name and email by list of IDs in a given organization. operationId: getUserdataByIds parameters: - name: orgid in: path description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1 - name: page in: query description: Defines the number of displayed page. The page number starts from 0. schema: type: integer default: 0 - name: pageSize in: query description: Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size. schema: type: integer default: 10 requestBody: content: application/json: schema: $ref: '#/components/schemas/UserDetailsRequestDTO' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/UserDetailsResponseEnvelopeDTO' application/hal+json: schema: $ref: '#/components/schemas/UserDetailsResponseEnvelopeDTO' '400': description: The request was invalid and cannot be served. An accompanying error message will explain further content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '400' reason: Test reason message: - description: Test error code: '400' entity: cc_user references: [] '401': description: Unauthorized Operation content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '401' reason: Test reason message: - description: Test error code: '401' entity: cc_user references: [] '403': description: Operation is forbidden content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '403' reason: Test reason message: - description: Test error code: '403' entity: cc_user references: [] '409': description: Similar entity is already present content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '409' reason: Test reason message: - description: Test error code: '409' entity: cc_user references: [] '429': description: Too many requests have been sent in a given amount of time and the request has been rate limited content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '429' reason: Test reason message: - description: Test error code: '429' entity: cc_user references: [] '500': description: An Unexpected Error Occurred content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '500' reason: Test reason message: - description: Test error code: '500' entity: cc_user references: [] /organization/{orgid}/user/with-user-profile: get: tags: - Users summary: List Users along with profile description: Retrieve a list of User(s) along with their UserProfiles in a given organization. operationId: getAllUsersWithUserProfile parameters: - name: orgid in: path description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1 responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/UserResponseDTO' application/hal+json: schema: type: array items: $ref: '#/components/schemas/UserResponseDTO' '401': description: Unauthorized Operation content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '401' reason: Test reason message: - description: Test error code: '401' entity: cc_user references: [] '403': description: Operation is forbidden content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '403' reason: Test reason message: - description: Test error code: '403' entity: cc_user references: [] '404': description: Resource not found or URI is invalid content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '404' reason: Test reason message: - description: Test error code: '404' entity: cc_user references: [] '429': description: Too many requests have been sent in a given amount of time and the request has been rate limited content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '429' reason: Test reason message: - description: Test error code: '429' entity: cc_user references: [] '500': description: An Unexpected Error Occurred content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '500' reason: Test reason message: - description: Test error code: '500' entity: cc_user references: [] /organization/{orgid}/user/with-user-profile/{id}: get: tags: - Users summary: Get specific User along with profile by ID description: Retrieve an existing User along with the corresponding UserProfile by ID in a given organization. operationId: getUserWithUserProfile parameters: - name: orgid in: path description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1 - name: id in: path description: Resource ID of the User. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2 responses: '200': description: OK content: application/hal+json: schema: $ref: '#/components/schemas/UserResponseDTO' application/json: schema: $ref: '#/components/schemas/UserResponseDTO' '401': description: Unauthorized Operation content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '401' reason: Test reason message: - description: Test error code: '401' entity: cc_user references: [] '403': description: Operation is forbidden content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '403' reason: Test reason message: - description: Test error code: '403' entity: cc_user references: [] '404': description: Resource not found or URI is invalid content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '404' reason: Test reason message: - description: Test error code: '404' entity: cc_user references: [] '429': description: Too many requests have been sent in a given amount of time and the request has been rate limited content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '429' reason: Test reason message: - description: Test error code: '429' entity: cc_user references: [] '500': description: An Unexpected Error Occurred content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '500' reason: Test reason message: - description: Test error code: '500' entity: cc_user references: [] /organization/{orgid}/user/{id}: get: tags: - Users summary: Get specific User by ID description: Retrieve an existing Users by ID in a given organization. operationId: getConfig_2 parameters: - name: orgid in: path description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1 - name: id in: path description: Resource ID of the User. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2 - name: includeCount in: query description: If set to true, the API response will include the count of each type of Contact Service Queues that the user is assigned to schema: type: boolean default: false - name: includeUserProfileType in: query description: If set to true, the API response will include the user profile schema: type: boolean default: false - name: includeSkillProfileAudit in: query description: If set to true gives skill profile modification info. schema: type: boolean default: false example: false - name: includeReskillAuditInfo in: query description: If set to true gives skill profile and dynamic skill modification info. schema: type: boolean default: false example: false - name: includeSkillDetails in: query description: If set to true,the response includes skill information for each dynamic skill assignment schema: type: boolean default: false responses: '200': description: OK content: application/hal+json: schema: $ref: '#/components/schemas/UserResponseDTO' application/json: schema: $ref: '#/components/schemas/UserResponseDTO' '401': description: Unauthorized Operation content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '401' reason: Test reason message: - description: Test error code: '401' entity: cc_user references: [] '403': description: Operation is forbidden content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '403' reason: Test reason message: - description: Test error code: '403' entity: cc_user references: [] '404': description: Resource not found or URI is invalid content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '404' reason: Test reason message: - description: Test error code: '404' entity: cc_user references: [] '429': description: Too many requests have been sent in a given amount of time and the request has been rate limited content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '429' reason: Test reason message: - description: Test error code: '429' entity: cc_user references: [] '500': description: An Unexpected Error Occurred content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '500' reason: Test reason message: - description: Test error code: '500' entity: cc_user references: [] put: tags: - Users summary: Update specific User by ID description: Update an existing User by ID in a given organization. operationId: updateConfig_2 parameters: - name: orgid in: path description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1 - name: id in: path description: Resource ID of the User. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2 requestBody: content: application/json: schema: $ref: '#/components/schemas/UserDTO' required: true responses: '200': description: OK content: application/hal+json: schema: $ref: '#/components/schemas/UserResponseDTO' application/json: schema: $ref: '#/components/schemas/UserResponseDTO' '400': description: The request was invalid and cannot be served. An accompanying error message will explain further content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '400' reason: Test reason message: - description: Test error code: '400' entity: cc_user references: [] '401': description: Unauthorized Operation content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '401' reason: Test reason message: - description: Test error code: '401' entity: cc_user references: [] '403': description: Operation is forbidden content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '403' reason: Test reason message: - description: Test error code: '403' entity: cc_user references: [] '404': description: Resource not found or URI is invalid content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '404' reason: Test reason message: - description: Test error code: '404' entity: cc_user references: [] '412': description: Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api. content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '412' reason: Test reason message: - description: Test error code: '412' entity: cc_user references: [] '429': description: Too many requests have been sent in a given amount of time and the request has been rate limited content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '429' reason: Test reason message: - description: Test error code: '429' entity: cc_user references: [] '500': description: An Unexpected Error Occurred content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '500' reason: Test reason message: - description: Test error code: '500' entity: cc_user references: [] patch: tags: - Users summary: Partially update User by ID description: Partially update User by ID in a given organization. operationId: patchConfig parameters: - name: orgid in: path description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1 - name: id in: path description: Resource ID of the User. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2 requestBody: content: application/json: schema: $ref: '#/components/schemas/JsonValue' multipart/form-data: schema: $ref: '#/components/schemas/JsonValue' required: true responses: '200': description: OK content: application/hal+json: schema: $ref: '#/components/schemas/UserResponseDTO' application/json: schema: $ref: '#/components/schemas/UserResponseDTO' '400': description: The request was invalid and cannot be served. An accompanying error message will explain further content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '400' reason: Test reason message: - description: Test error code: '400' entity: cc_user references: [] '401': description: Unauthorized Operation content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '401' reason: Test reason message: - description: Test error code: '401' entity: cc_user references: [] '403': description: Operation is forbidden content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '403' reason: Test reason message: - description: Test error code: '403' entity: cc_user references: [] '404': description: Resource not found or URI is invalid content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '404' reason: Test reason message: - description: Test error code: '404' entity: cc_user references: [] '429': description: Too many requests have been sent in a given amount of time and the request has been rate limited content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '429' reason: Test reason message: - description: Test error code: '429' entity: cc_user references: [] '500': description: An Unexpected Error Occurred content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '500' reason: Test reason message: - description: Test error code: '500' entity: cc_user references: [] /organization/{orgid}/user/{id}/incoming-references: get: tags: - Users summary: List references for a specific User description: Retrieve a list of all entities that have reference to an existing User by ID in a given organization. operationId: getIncomingReferences_1 parameters: - name: orgid in: path description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1 - name: id in: path description: ID of this contact center resource. required: true schema: type: string example: af9eecc5-0472-4549-9a83-2afdae0d4ba0 - name: type in: query description: Entity type of the other entity that has a reference to this specific entity. required: false schema: type: string example: type_text - name: page in: query description: Defines the number of displayed page. The page number starts from 0. schema: type: integer default: 0 example: 0 example: 0 - name: pageSize in: query description: Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size. schema: type: integer default: 100 example: 100 example: 100 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/EntityReferenceInfoDTO' application/hal+json: schema: $ref: '#/components/schemas/EntityReferenceInfoDTO' '401': description: Unauthorized Operation content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '401' reason: Test reason message: - description: Test error code: '401' entity: cc_user references: [] '403': description: Operation is forbidden content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '403' reason: Test reason message: - description: Test error code: '403' entity: cc_user references: [] '404': description: Resource not found or URI is invalid content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '404' reason: Test reason message: - description: Test error code: '404' entity: cc_user references: [] '429': description: Too many requests have been sent in a given amount of time and the request has been rate limited content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '429' reason: Test reason message: - description: Test error code: '429' entity: cc_user references: [] '500': description: An Unexpected Error Occurred content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '500' reason: Test reason message: - description: Test error code: '500' entity: cc_user references: [] /organization/{orgid}/user/{id}/reskill: patch: tags: - Users summary: Reskill Agents description: Reskill agents by assigning or unassigning skills. operationId: reSkillAgent parameters: - name: orgid in: path description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1 - name: id in: path description: Resource ID of the User. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2 requestBody: content: application/json: schema: $ref: '#/components/schemas/ReSkillAgentRequestDTO' required: true responses: '204': description: No Content '400': description: The request was invalid and cannot be served. An accompanying error message will explain further content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '400' reason: Test reason message: - description: Test error code: '400' entity: cc_user references: [] '401': description: Unauthorized Operation content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '401' reason: Test reason message: - description: Test error code: '401' entity: cc_user references: [] '403': description: Operation is forbidden content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '403' reason: Test reason message: - description: Test error code: '403' entity: cc_user references: [] '404': description: Resource not found or URI is invalid content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '404' reason: Test reason message: - description: Test error code: '404' entity: cc_user references: [] '429': description: Too many requests have been sent in a given amount of time and the request has been rate limited content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '429' reason: Test reason message: - description: Test error code: '429' entity: cc_user references: [] '500': description: An Unexpected Error Occurred content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '500' reason: Test reason message: - description: Test error code: '500' entity: cc_user references: [] /organization/{orgid}/v2/user: get: tags: - Users summary: List User(s) description: Retrieve a list of User(s) in a given organization. operationId: getAllConfigWithPagedMetaData_1 parameters: - name: orgid in: path description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1 - name: filter in: query description: "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n" required: false schema: type: string example: id=="57efb0e6-5af0-4245-a67d-d3c5045cdb6e" - name: attributes in: query description: Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. required: false schema: type: string format: string example: id - name: search in: query description: 'Filter data based on the search keyword.Supported search columns(firstName, lastName, email) The examples below show some search queries - "Cisco" - field=="firstName";value=="Cisco" - fields=in=("firstName","lastName");value=="Cisco" ' required: false schema: type: string example: contact center - name: page in: query description: Defines the number of displayed page. The page number starts from 0. schema: type: integer default: 0 example: 0 example: 0 - name: pageSize in: query description: Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size. schema: type: integer default: 100 example: 100 example: 100 - name: supervisorManagedAgentsOnly in: query description: If set to true, the API will return contact center enabled users based on the invoking supervisor user's user profile access rights to sites and teams. schema: type: boolean default: false example: false - name: singleObjectResponse in: query description: Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception. schema: type: boolean default: false example: false - name: buddyTeamAgentsOnly in: query description: If set to true, returns only users who are part of buddy teams without PBAC check. schema: type: boolean default: false example: false - name: userInQueue in: query description: Can be either assigned or unassigned. If passed, returns the users who are assigned or not assigned to an agent based queue managed by the supervisor. schema: type: string example: assigned - name: queueId in: query description: Contact Service Queue Id for which the list of assigned/unassigned agents needs to be fetched. schema: type: string example: af9eecc5-0472-4549-9a83-2afdae0d4ba0 - name: includeAIMappingCount in: query description: If set to true, the API response will include the count of each AI features mapped to the entity. schema: type: boolean default: false - name: includeDynamicSkillsLimitReached in: query description: If true, includes whether each user has reached the dynamic skills assignment limit. schema: type: boolean default: false responses: '200': description: OK content: application/json: schema: type: object properties: meta: $ref: '#/components/schemas/MetaDataPagedUser' data: type: array items: $ref: '#/components/schemas/UserResponseDTO' example: data: - imiUserCreated: false lastName: Wick userLevelSummariesInclusion: INCLUDED timezone: America/New_York preferredSupervisorTeamId: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1 organizationId: f53c8b54-46ca-43f6-ba05-08426a46e23d broadCloudUserId: 1dq21e23-1234-5578-9a83-2afdae0d4ba1 externalIdentifier: '121212' createdTime: 1679393400000 lastUpdatedTime: 1679393400000 id: 93912f11-6017-404b-bf14-5331890b1797 contactCenterEnabled: true email: johnwick@company.com ciUserId: 1dq21e23-1234-5578-9a83-2afdae0d4ba1 xspVersion: xsp-24.0 userLevelAutoCSATInclusion: INCLUDED mobile: '1234567890' active: true version: 1 skillProfileId: f53c8b54-46ca-43f6-ba05-08426a46e23d firstName: John userLevelWellnessBreakReminders: DISABLED agentProfileId: 8e6bb6da-2a78-4768-bef9-7e229f92af22 siteId: 8e6bb6da-2a78-4768-bef9-7e229f92af22 userLevelBurnoutInclusion: INCLUDED workPhone: '1234567890' userProfileId: 1dq21e23-1234-5578-9a83-2afdae0d4ba1 multimediaProfileId: f53c8b54-46ca-43f6-ba05-08426a46e23d subscriptionId: 04d0bdf6-6d6a-4aae-8a8a-71c9152e6478 deafultDialledNumber: '1234567890' meta: additionalProp1: string additionalProp2: string additionalProp3: string application/hal+json: schema: type: object properties: meta: $ref: '#/components/schemas/MetaDataPagedUser' data: type: array items: $ref: '#/components/schemas/UserResponseDTO' example: data: - imiUserCreated: false lastName: Wick userLevelSummariesInclusion: INCLUDED timezone: America/New_York preferredSupervisorTeamId: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1 organizationId: f53c8b54-46ca-43f6-ba05-08426a46e23d broadCloudUserId: 1dq21e23-1234-5578-9a83-2afdae0d4ba1 externalIdentifier: '121212' createdTime: 1679393400000 lastUpdatedTime: 1679393400000 id: 93912f11-6017-404b-bf14-5331890b1797 contactCenterEnabled: true email: johnwick@company.com ciUserId: 1dq21e23-1234-5578-9a83-2afdae0d4ba1 xspVersion: xsp-24.0 userLevelAutoCSATInclusion: INCLUDED mobile: 1234567890 active: true version: 1 skillProfileId: f53c8b54-46ca-43f6-ba05-08426a46e23d firstName: John userLevelWellnessBreakReminders: DISABLED agentProfileId: 8e6bb6da-2a78-4768-bef9-7e229f92af22 siteId: 8e6bb6da-2a78-4768-bef9-7e229f92af22 userLevelBurnoutInclusion: INCLUDED workPhone: 1234567890 userProfileId: 1dq21e23-1234-5578-9a83-2afdae0d4ba1 multimediaProfileId: f53c8b54-46ca-43f6-ba05-08426a46e23d subscriptionId: 04d0bdf6-6d6a-4aae-8a8a-71c9152e6478 deafultDialledNumber: 1234567890 meta: additionalProp1: string additionalProp2: string additionalProp3: string '401': description: Unauthorized Operation content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '401' reason: Test reason message: - description: Test error code: '401' entity: cc_user references: [] '403': description: Operation is forbidden content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '403' reason: Test reason message: - description: Test error code: '403' entity: cc_user references: [] '404': description: Resource not found or URI is invalid content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '404' reason: Test reason message: - description: Test error code: '404' entity: cc_user references: [] '429': description: Too many requests have been sent in a given amount of time and the request has been rate limited content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '429' reason: Test reason message: - description: Test error code: '429' entity: cc_user references: [] '500': description: An Unexpected Error Occurred content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '500' reason: Test reason message: - description: Test error code: '500' entity: cc_user references: [] /organization/{orgid}/v2/user/by-ci-user-id/{id}: get: tags: - Users summary: Get specific User by CI User ID description: Retrieve an existing User using the CI ID in a given organization. operationId: getUserByCiUserIdWithUserProfileGranularAccess parameters: - name: orgid in: path description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1 - name: id in: path description: CI ID of the User. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2 - name: includeUserProfile in: query description: Specifiy whether to include user profile data required: false schema: type: boolean example: true - name: includeNames in: query description: Specifiy whether to include resource collection names required: false schema: type: boolean example: true responses: '200': description: OK content: application/hal+json: schema: $ref: '#/components/schemas/UserResponseDTO_UserResponseWithUserProfileGranularAccess' application/json: schema: $ref: '#/components/schemas/UserResponseDTO_UserResponseWithUserProfileGranularAccess' '401': description: Unauthorized Operation content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '401' reason: Test reason message: - description: Test error code: '401' entity: cc_user references: [] '403': description: Operation is forbidden content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '403' reason: Test reason message: - description: Test error code: '403' entity: cc_user references: [] '404': description: Resource not found or URI is invalid content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '404' reason: Test reason message: - description: Test error code: '404' entity: cc_user references: [] '429': description: Too many requests have been sent in a given amount of time and the request has been rate limited content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '429' reason: Test reason message: - description: Test error code: '429' entity: cc_user references: [] '500': description: An Unexpected Error Occurred content: application/json: schema: $ref: '#/components/schemas/ApiErrorResponse' example: trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0 error: key: '500' reason: Test reason message: - description: Test error code: '500' entity: cc_user references: [] components: schemas: UserProfilePermissionsDTO: type: object description: User Profile Permissions DTO properties: id: type: string description: The id of the user profile permission. example: 00734874-4732-43bb-bfff-d1e75d309eb1 name: type: string description: 'The name of the user profile permission.audio-prompt — Has access to Audio Prompt[audio_prompt] permission. agent-personalized-greeting — Has access to Agent Personalized Greeting[agent_personalized_greeting] permission. holiday-list — Has access to Holiday List[holiday_list] permission. override — Has access to Override[override] permission. working-hour — Has access to Working Hour[working_hour] permission. call-recording-schedule — Has access to Call Recording Schedule[call_recording_schedule] permission. channel — Has access to Channel[channel] permission. support-number — Has access to Support Number[support_number] permission. flow-settings-override — Has access to Flow Settings Override[flow_settings_override] permission. queue — Has access to Queue[queue] permission. flow — Has access to Flow[flow] permission. function — Has access to Function[function] permission. global-variable — Has access to Global Variable[global_variable] permission. web-chat-asset — Has access to Web Chat Asset[web_chat_asset] permission. resource-collection — Has access to Resource Collection[resource_collection] permission. user-profile — Has access to User Profile[user_profile] permission. user — Has access to User[user] permission. site — Has access to Site[site] permission. skill-profile — Has access to Skill Profile[skill_profile] permission. skill-definition — Has access to Skill Definition[skill_definition] permission. team — Has access to Team[team] permission. address-book — Has access to Address Book[address_book] permission. agent-wellbeing — Has access to Agent Wellbeing[agent_wellbeing] permission. auto-csat — Has access to Auto CSAT[auto_csat] permission. generated-summary — Has access to Generated Summary[generated_summary] permission. real-time-transcription — Has access to Real Time Transcription[real_time_transcription] permission. suggested-response — Has access to Suggested Response[suggested_response] permission. desktop-layout — Has access to Desktop Layout[desktop_layout] permission. desktop-profile — Has access to Desktop Profile[desktop_profile] permission. dial-plan — Has access to Dial Plan[dial_plan] permission. multimedia-profile — Has access to Multimedia Profile[multimedia_profile] permission. idle-wrapup-code — Has access to Idle Wrap-Up Code[idle_wrapup_code] permission. outdial-ani — Has access to Outdial ANI[outdial_ani] permission. quick-reply — Has access to Quick Reply[quick_reply] permission. api-key — Has access to API Key[api_key] permission. audit-trail — Has access to Audit Trail[audit_trail] permission. business-rules-engine — Has access to Business Rules Engine[business_rules_engine] permission. campaign-manager — Has access to Campaign Manager[campaign_manager] permission. routing-strategy — Has access to Routing Strategy[routing_strategy] permission. tenant-setting — Has access to Tenant Setting[tenant_setting] permission. audio-recording-transcript — Has access to Audio Recording Transcript[audio_recording_transcript] permission. tag — Has access to Tag[tag] permission. additional-supervisory — Has access to Additional Supervisory[additional_supervisory] permission. change-agent-state — Has access to Change Agent State[change_agent_state] permission. manage-agent-queues-assignment — Has access to Manage Agent Queues Assignment[manage_agent_queues_assignment] permission. reskill-agent — Has access to Reskill Agent[reskill_agent] permission. send-message — Has access to Send Message[send_message] permission. sign-out-agent — Has access to Sign Out Agent[sign_out_agent] permission. analyzer — Has access to Analyzer[analyzer] permission. call-monitoring — Has access to Call Monitoring[call_monitoring] permission. barge-in — Has access to Barge-In[barge_in] permission. whisper-coach — Has access to Whisper Coach[whisper_coach] permission. restricted-monitor-only — Has access to Restricted Monitor Only[restricted_monitor_only] permission. view-blind-monitor-request — Has access to View Blind Monitor Request[view_blind_monitor_request] permission. mid-call-monitor — Has access to Mid-Call Monitor[mid_call_monitor] permission. threshold-rule — Has access to Threshold Rule[threshold_rule] permission. multimedia — Has access to Multimedia[multimedia] permission. basic-digital — Has access to Basic Digital[basic_digital] permission. social-channel — Has access to Social Channel[social_channel] permission. coaching-insights — Has access to Coaching Insights[coaching-insights] permission. sentiment-analysis — Has access to Sentiment Analysis[sentiment-analysis] permission. evaluations-analytics — Has access to Evaluations Analytics[evaluations-analytics] permission. coaching-insights-assignment — Has access to Coaching Insights Assignment[coaching-insights-assignment] permission. evaluation-forms-assignment — Has access to Evaluation Forms Assignment[evaluation-forms-assignment] permission. evaluation-forms-manage — Has access to Evaluation Forms Manage[evaluation-forms-manage] permission. evaluation-forms-calibrate-questions — Has access to Evaluation Forms Calibrate Questions[evaluation-forms-calibrate-questions] permission. predicted-wait-time — Has access to Predicted Wait Time[predicted-wait-time] permission. personalized-ai-routing — Has access to Personalized AI Routing[personalized-ai-routing] permission. ' example: sites minLength: 1 access: type: string description: 'Indicates the access rights for a user of this profile for a Webex Contact Center module. It can take be one of these values: VIEW — A contact center user with this profile has read only access to a Contact Center module. EDIT — A contact center user with this profile has read and write access to a Contact Center module. NONE — A contact center user with this profile cannot access the module. ' enum: - EDIT - VIEW - NONE - ENABLED - DISABLED example: NONE required: - name UserProfileAppFeatureDTO: type: object properties: organizationId: type: string format: uuid description: ID of the contact center organization. This field is required for all bulk save operations. example: f53c8b54-46ca-43f6-ba05-08426a46e23d maxLength: 36 minLength: 32 pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$ id: type: string description: ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource. example: 93912f11-6017-404b-bf14-5331890b1797 version: type: integer format: int32 description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise. example: 1 appFeatureId: type: string description: "The feature code of a Webex Contact Center module. \n\nPlease add all the following features with their respective modules and set it's featureAccessType to 'ON' or 'OFF', to specify if it is in use. Here is the complete list of Feature names and Feature Ids:\n\n\nFor module 'm_additional_supervisory_features' we have the following features:\n\nChange Agent States : f_change_agent_states\n\nSign out Agents : f_sign_out_agents\n\nSend Messages : f_send_messages\n\nRe-skill Agents : f_reskill_agents\n\nManage agent based queues : f_manage_agent_queue_assignments\n\nFor module 'm_real_time_reports' we have the following features:\n\nReal Time Threshold Alerts : f_realtime_threshold_alerts\n\nAgent State Change : f_agent_state_change\n\nSummary View : f_summary_view\n\nWeb Callback Report : f_web_callback_report\n\n\nFor module 'm_multimedia' we have the following features:\n\nMM Agent Desktop : f_mm_agent_desktop\n\nBasic Digital : f_mm_basic_digital\n\nMM Provisioning : f_mm_provisioning\n\nSocial Channel : f_mm_social_channel\n\n\nFor module 'm_reporting_analytics' we have the following features:\n\nAnalyzer Data Exchange : f_analyzer_data_exchange\n\nBusiness Rules : f_business_rules\n\n\nFor module 'm_manage_agent_states' we have the following features:\n\nChange Agent State : f_change_agent_state\n\nSign Out Agent : f_sign_out_agent\n\n\nFor module 'm_recording_management' we have the following features:\n\nCustom Attributes : f_custom_attributes\n\nManage Recordings : f_manage_recordings\n\nTags : f_tags\n\nSecurity Keys : f_security_keys\n\n\nFor module 'm_routing_strategy' we have the following features:\n\nManage Call Flow Scripts : f_manage_call_flow_scripts\n\nManage Media Files : f_manage_media_files\n\n\nFor module 'm_provisioning' we have the following features:\n\nManage EntryPoints and Queues : f_manage_teams\n\nManage Users : f_manage_users\n\nDN Mappings : f_dn_mappings\n\nManage Sites : f_manage_sites\n\nManage Teams : f_manage_teams\n\nManage User Profiles : f_manage_user_profiles\n\nRevoke API Key : f_revoke_api_key\n\nManage Dial Plans : f_manage_dial_plans\n\nManage Tenants : f_manage_tenants\n\nManage Entry Points and Queues : f_manage_entrypt_queue\n\nPortal Branding : f_portal_branding\n\nAudit Trail : f_audit_trail\n\nManage Business Hours : f_manage_business_hours\n\n\nFor module 'm_call_monitoring' we have the following features:\n\nMid Call Monitoring : f_mid_call_monitor\n\nBarge In : f_barge_in\n\nRestricted Monitor : f_restricted_monitor_only\n\nWhisper Coach : f_whisper_coach\n\nView Blind Monitor Request : f_view_blind_monitor_requests\n\n" example: f_manage_sites minLength: 1 appFeatureName: type: string description: The feature name of the Webex Contact Center module. example: Manage Sites featureAccessType: type: string description: 'Indicates whether a user of this profile has access to a module feature. It can be one of these values: OFF — A contact center user with this profile cannot access this module feature. ON — A contact center user with this profile can access this module feature. ' enum: - 'OFF' - 'ON' example: 'ON' createdTime: type: integer format: int64 description: This is the created time of the entity. lastUpdatedTime: type: integer format: int64 description: This is the updated time of the entity. required: - appFeatureId - featureAccessType ApiErrorResponse: description: Response body for an API error. type: object properties: trackingId: type: string description: "An opaque identifier for mapping protocol failures to service internal codes. \n\nWhen specified in a request, it can be used for co-relating events across services" example: c1a4fcef-aee2-4dea-8977-29f594760552 error: description: An object containing details about the error. $ref: '#/components/schemas/ErrorDetails' UserProfileDTO_UserResponseWithUserProfile: type: object description: Details of UserProfile which a Contact Center administrator has configured for the user.This is an optional object, returned only when the endpoint 'Get User along with profile by ID' is invoked. properties: organizationId: type: string format: uuid description: ID of the contact center organization. This field is required for all bulk save operations. example: f53c8b54-46ca-43f6-ba05-08426a46e23d maxLength: 36 minLength: 32 pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$ id: type: string description: ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource. example: 93912f11-6017-404b-bf14-5331890b1797 version: type: integer format: int32 description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise. example: 1 name: type: string description: The name of the user profile. example: Contact Center Admin Profile maxLength: 80 minLength: 0 pattern: ^[a-zA-Z0-9,_\-\s]*$ description: type: string description: An optional description of the profile. example: This profile should be applied only to contact center admins. maxLength: 255 minLength: 0 profileType: type: string description: "The type determines the privileges applicable for a profile.\n\nIt can take one of these values:\n\nSTANDARD_AGENT — Has access to Agent Desktop[m_agent_desktop] module.\n\nPREMIUM_AGENT — Has access to Agent Desktop[m_agent_desktop] and Multimedia[m_multimedia] module.\n\nSUPERVISOR — Has access to all modules except to manage tenants in the Provisioning[m_provisioning] module.\n\nADMINISTRATOR — Has access to all modules.\n\nADMINISTRATOR_ONLY — Has access to Provisioning[m_provisioning], Real Time Reports[m_real_time_reports], Call Recording[m_call_recording], IMI Digital Channels[m_imi_digital_channels], and Routing Strategy[m_routing_strategy] modules.\n\nIt is required only during a create operation. \n\nThe profile type cannot be changed for an existing user profile.\n\n" enum: - ADMINISTRATOR - ADMINISTRATOR_ONLY - SUPERVISOR - PREMIUM_AGENT - STANDARD_AGENT - ANALYZER_ADMINISTRATOR - ANALYZER_SUPERVISOR - ANALYZER_USER example: PREMIUM_AGENT accessAllModules: type: string description: 'This can be used to allow users of this profile access to specific or all the Webex Contact Center modules. It can take one of these values: ALL — A contact center user with this profile can access all Contact Center modules. SPECIFIC — A contact center user with this profile can access only specific modules. ' enum: - SPECIFIC - ALL - PROVISIONED_VALUE - NONE example: ALL userProfileAppModules: type: array description: 'Specifies the module(s) a user of this profile has access to. It should be chosen when module access is SPECIFIC. Please specify all the following modules and their respective access type. ' items: $ref: '#/components/schemas/UserProfileAppModuleDTO_UserResponseWithUserProfile' uniqueItems: true accessAllEntryPoints: type: string description: 'Allow users of this profile access to specific or all the entry points for an organization. It can take one of these values: ALL — A contact center user with this profile can access all the entry points for an organization. SPECIFIC — A contact center user with this profile can access only specific entry points for an organization. ' enum: - SPECIFIC - ALL - PROVISIONED_VALUE - NONE example: ALL accessAllSites: type: string description: 'Allow users of this profile access to specific or all the sites for an organization. It can take one of these values: ALL — A contact center user with this profile can access all the sites for an organization. SPECIFIC — A contact center user with this profile can access only specific sites for an organization. ' enum: - SPECIFIC - ALL - PROVISIONED_VALUE - NONE example: ALL accessAllQueues: type: string description: 'Allow users of this profile access to specific or all the contact center queues for an organization. It can take one of these values: ALL — A contact center user with this profile can access all the contact center queues for an organization. SPECIFIC — A contact center user with this profile can access only specific contact center queues for an organization. ' enum: - SPECIFIC - ALL - PROVISIONED_VALUE - NONE example: ALL accessAllTeams: type: string description: 'Allow users of this profile access to specific or all the contact center teams for an organization. It can take one of these values: ALL — A contact center user with this profile can access all the contact center teams for an organization. SPECIFIC — A contact center user with this profile can access only specific contact center teams for an organization. ' enum: - SPECIFIC - ALL - PROVISIONED_VALUE - NONE example: ALL active: type: boolean description: Specify whether the User profile is active or not. example: true editableFolderIds: type: array description: "Indicates the id(s) of the reporting folders a user of this profile has read and write access to. \n" example: - 1 - 2 items: type: integer format: int32 description: "Indicates the id(s) of the reporting folders a user of this profile has read and write access to. \n" example: 1 uniqueItems: true viewableFolderIds: type: array description: "Indicates the id(s) of the reporting folders a user of this profile has read access to. \n" example: - 1 - 2 items: type: integer format: int32 description: "Indicates the id(s) of the reporting folders a user of this profile has read access to. \n" example: 1 uniqueItems: true nonViewableFolderIds: type: array description: "Indicates the id(s) of the restricted reporting folders for a user of this profile. \n" example: - 1 - 2 items: type: integer format: int32 description: "Indicates the id(s) of the restricted reporting folders for a user of this profile. \n" example: 1 uniqueItems: true systemDefault: type: boolean description: Indicates whether the created resource is system created or not example: false createdTime: type: integer format: int64 description: This is the created time of the entity. lastUpdatedTime: type: integer format: int64 description: This is the updated time of the entity. entryPoints: type: array description: "Specify the id(s) of the entry point(s) a user of this profile will have access to. \n\nIt should be chosen when entry points access is SPECIFIC. Please see '''Entry Point documentation''', and use Get EntryPoints API to fetch the values of entry points.\n\n" example: - f53c8b54-46ca-43f6-ba05-08426a46e23d - a53c8b54-46ca-43f6-ba05-08426a46e23f items: type: string description: "Specify the id(s) of the entry point(s) a user of this profile will have access to. \n\nIt should be chosen when entry points access is SPECIFIC. Please see '''Entry Point documentation''', and use Get EntryPoints API to fetch the values of entry points.\n\n" example: f53c8b54-46ca-43f6-ba05-08426a46e23d uniqueItems: true sites: type: array description: "Specify the id(s) of the site(s) a user of this profile will have access to. \nIt should be chosen when sites access is SPECIFIC. Please see Sites documentation, and use Get Site API to fetch the values of site IDs.\n\n" example: - f53c8b54-46ca-43f6-ba05-08426a46e23d - a53c8b54-46ca-43f6-ba05-08426a46e23f items: type: string description: "Specify the id(s) of the site(s) a user of this profile will have access to. \nIt should be chosen when sites access is SPECIFIC. Please see Sites documentation, and use Get Site API to fetch the values of site IDs.\n\n" example: f53c8b54-46ca-43f6-ba05-08426a46e23d uniqueItems: true queues: type: array description: "Specify the id(s) of the queue(s) a user of this profile will have access to. \nIt should be chosen when queues access is SPECIFIC. Please see Queues documentation, and use Get Queues API to fetch the values of queue IDs.\n\n" example: - f53c8b54-46ca-43f6-ba05-08426a46e23d - a53c8b54-46ca-43f6-ba05-08426a46e23f items: type: string description: "Specify the id(s) of the queue(s) a user of this profile will have access to. \nIt should be chosen when queues access is SPECIFIC. Please see Queues documentation, and use Get Queues API to fetch the values of queue IDs.\n\n" example: f53c8b54-46ca-43f6-ba05-08426a46e23d uniqueItems: true teams: type: array description: 'Specify the id(s) of the team(s) a user of this profile will have access to. It should be chosen when teams access is SPECIFIC. Please see Teams documentation, and use Get Teams API to fetch the values of team IDs. ' example: - f53c8b54-46ca-43f6-ba05-08426a46e23d - a53c8b54-46ca-43f6-ba05-08426a46e23f items: type: string description: 'Specify the id(s) of the team(s) a user of this profile will have access to. It should be chosen when teams access is SPECIFIC. Please see Teams documentation, and use Get Teams API to fetch the values of team IDs. ' example: f53c8b54-46ca-43f6-ba05-08426a46e23d uniqueItems: true required: - accessAllEntryPoints - accessAllModules - accessAllQueues - accessAllSites - accessAllTeams - active - name - profileType ReSkillAgentRequestDTO: type: object properties: organizationId: type: string format: uuid description: ID of the contact center organization. This field is required for all bulk save operations. example: f53c8b54-46ca-43f6-ba05-08426a46e23d maxLength: 36 minLength: 32 pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$ id: type: string description: ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource. example: 93912f11-6017-404b-bf14-5331890b1797 version: type: integer format: int32 description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise. example: 1 skillProfileId: type: string description: The identifier of the skill profile to assign to the agent. dynamicSkills: $ref: '#/components/schemas/DynamicSkills' createdTime: type: integer format: int64 description: This is the created time of the entity. lastUpdatedTime: type: integer format: int64 description: This is the updated time of the entity. ResourceTypesDTO: type: object description: A resource type with its access level and associated IDs. properties: name: type: string description: 'The name of the resource.multimedia-profile - Has access to multimedia profile[multimedia-profile] resource name. queue - Has access to queue[queue] resource name. override - Has access to override[override] resource name. holiday-list - Has access to holiday list[holiday-list] resource name. audio-prompt - Has access to audio prompt[audio-prompt] resource name. flow - Has access to flow[flow] resource name. skill-profile - Has access to skill profile[skill-profile] resource name. team - Has access to team[team] resource name. skill-definition - Has access to skill definition[skill-definition] resource name. site - Has access to site[site] resource name. outdial-ani - Has access to outdial ani[outdial-ani] resource name. channel - Has access to channel[channel] resource name. sub-flow - Has access to sub flow[sub-flow] resource name. desktop-layout - Has access to desktop layout[desktop-layout] resource name. working-hour - Has access to working hour[working-hour] resource name. function - Has access to function[function] resource name. desktop-profile - Has access to desktop profile[desktop-profile] resource name. idle-wrapup-code - Has access to idle wrap-up code[idle-wrapup-code] resource name. cad-variable - Has access to cad variable[cad-variable] resource name. address-book - Has access to address book[address-book] resource name. ' example: site minLength: 1 accessLevel: type: string description: This can be used to allow users to access specific, none or all resources. enum: - SPECIFIC - ALL - PROVISIONED_VALUE - NONE example: ALL ids: type: array description: The id of the resource can be used to allow users to access specific, of resources. example: - 00734874-4732-43bb-bfff-d1e75d309eb1 - 00734874-4732-43bb-bfff-d1e75d309eb2 items: type: string uniqueItems: true required: - accessLevel - name UserDynamicSkillResponseDTO: type: object description: The response object for a user's dynamic skill details. properties: organizationId: type: string format: uuid description: ID of the contact center organization. This field is required for all bulk save operations. example: f53c8b54-46ca-43f6-ba05-08426a46e23d maxLength: 36 minLength: 32 pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$ id: type: string description: ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource. example: 93912f11-6017-404b-bf14-5331890b1797 firstName: type: string description: The first name of the user. example: John lastName: type: string description: The last name of the user. example: Wick email: type: string description: The email address of the user. example: johnwick@company.com dynamicSkill: $ref: '#/components/schemas/AssignedDynamicSkillsDTO' description: The dynamic skill associated with the user UserProfilePermissionsDTO_UserResponseWithUserProfileGranularAccess: type: object description: User Profile Permissions DTO properties: id: type: string description: The id of the user profile permission. example: 00734874-4732-43bb-bfff-d1e75d309eb1 name: type: string description: 'The name of the user profile permission.audio-prompt — Has access to Audio Prompt[audio_prompt] permission. agent-personalized-greeting — Has access to Agent Personalized Greeting[agent_personalized_greeting] permission. holiday-list — Has access to Holiday List[holiday_list] permission. override — Has access to Override[override] permission. working-hour — Has access to Working Hour[working_hour] permission. call-recording-schedule — Has access to Call Recording Schedule[call_recording_schedule] permission. channel — Has access to Channel[channel] permission. support-number — Has access to Support Number[support_number] permission. flow-settings-override — Has access to Flow Settings Override[flow_settings_override] permission. queue — Has access to Queue[queue] permission. flow — Has access to Flow[flow] permission. function — Has access to Function[function] permission. global-variable — Has access to Global Variable[global_variable] permission. web-chat-asset — Has access to Web Chat Asset[web_chat_asset] permission. resource-collection — Has access to Resource Collection[resource_collection] permission. user-profile — Has access to User Profile[user_profile] permission. user — Has access to User[user] permission. site — Has access to Site[site] permission. skill-profile — Has access to Skill Profile[skill_profile] permission. skill-definition — Has access to Skill Definition[skill_definition] permission. team — Has access to Team[team] permission. address-book — Has access to Address Book[address_book] permission. agent-wellbeing — Has access to Agent Wellbeing[agent_wellbeing] permission. auto-csat — Has access to Auto CSAT[auto_csat] permission. generated-summary — Has access to Generated Summary[generated_summary] permission. real-time-transcription — Has access to Real Time Transcription[real_time_transcription] permission. suggested-response — Has access to Suggested Response[suggested_response] permission. desktop-layout — Has access to Desktop Layout[desktop_layout] permission. desktop-profile — Has access to Desktop Profile[desktop_profile] permission. dial-plan — Has access to Dial Plan[dial_plan] permission. multimedia-profile — Has access to Multimedia Profile[multimedia_profile] permission. idle-wrapup-code — Has access to Idle Wrap-Up Code[idle_wrapup_code] permission. outdial-ani — Has access to Outdial ANI[outdial_ani] permission. quick-reply — Has access to Quick Reply[quick_reply] permission. api-key — Has access to API Key[api_key] permission. audit-trail — Has access to Audit Trail[audit_trail] permission. business-rules-engine — Has access to Business Rules Engine[business_rules_engine] permission. campaign-manager — Has access to Campaign Manager[campaign_manager] permission. routing-strategy — Has access to Routing Strategy[routing_strategy] permission. tenant-setting — Has access to Tenant Setting[tenant_setting] permission. audio-recording-transcript — Has access to Audio Recording Transcript[audio_recording_transcript] permission. tag — Has access to Tag[tag] permission. additional-supervisory — Has access to Additional Supervisory[additional_supervisory] permission. change-agent-state — Has access to Change Agent State[change_agent_state] permission. manage-agent-queues-assignment — Has access to Manage Agent Queues Assignment[manage_agent_queues_assignment] permission. reskill-agent — Has access to Reskill Agent[reskill_agent] permission. send-message — Has access to Send Message[send_message] permission. sign-out-agent — Has access to Sign Out Agent[sign_out_agent] permission. analyzer — Has access to Analyzer[analyzer] permission. call-monitoring — Has access to Call Monitoring[call_monitoring] permission. barge-in — Has access to Barge-In[barge_in] permission. whisper-coach — Has access to Whisper Coach[whisper_coach] permission. restricted-monitor-only — Has access to Restricted Monitor Only[restricted_monitor_only] permission. view-blind-monitor-request — Has access to View Blind Monitor Request[view_blind_monitor_request] permission. mid-call-monitor — Has access to Mid-Call Monitor[mid_call_monitor] permission. threshold-rule — Has access to Threshold Rule[threshold_rule] permission. multimedia — Has access to Multimedia[multimedia] permission. basic-digital — Has access to Basic Digital[basic_digital] permission. social-channel — Has access to Social Channel[social_channel] permission. coaching-insights — Has access to Coaching Insights[coaching-insights] permission. sentiment-analysis — Has access to Sentiment Analysis[sentiment-analysis] permission. evaluations-analytics — Has access to Evaluations Analytics[evaluations-analytics] permission. coaching-insights-assignment — Has access to Coaching Insights Assignment[coaching-insights-assignment] permission. evaluation-forms-assignment — Has access to Evaluation Forms Assignment[evaluation-forms-assignment] permission. evaluation-forms-manage — Has access to Evaluation Forms Manage[evaluation-forms-manage] permission. evaluation-forms-calibrate-questions — Has access to Evaluation Forms Calibrate Questions[evaluation-forms-calibrate-questions] permission. predicted-wait-time — Has access to Predicted Wait Time[predicted-wait-time] permission. personalized-ai-routing — Has access to Personalized AI Routing[personalized-ai-routing] permission. ' example: sites minLength: 1 access: type: string description: 'Indicates the access rights for a user of this profile for a Webex Contact Center module. It can take be one of these values: VIEW — A contact center user with this profile has read only access to a Contact Center module. EDIT — A contact center user with this profile has read and write access to a Contact Center module. NONE — A contact center user with this profile cannot access the module. ' enum: - EDIT - VIEW - NONE - ENABLED - DISABLED example: NONE required: - name UserProfileGranularAccessDTO: type: object description: Data Transfer Object for creating or updating a user profile with granular access controls. example: organizationId: f53c8b54-46ca-43f6-ba05-08426a46e23d id: 93912f11-6017-404b-bf14-5331890b1797 version: 1 name: Contact Center Admin Profile description: This profile should be applied only to contact center admins. profileType: PREMIUM_AGENT active: true permissionAccessLevel: ALL resourceAccessLevel: ALL permissions: - id: 00734874-4732-43bb-bfff-d1e75d309eb1 name: sites access: NONE editableFolderIds: - 1 - 2 viewableFolderIds: - 1 - 2 nonViewableFolderIds: - 1 - 2 systemDefault: false defaultResourceCollectionId: 80f49a6e-11d7-4651-b730-99ed2f726f61 resourceCollections: - id: 80f49a6e-11d7-4651-b730-99ed2f726f61 name: Department1 description: Department1 description. resources: - name: team accessLevel: SPECIFIC ids: - 00734874-4732-43bb-bfff-d1e75d309eb1 - 00734874-4732-43bb-bfff-d1e75d309eb2 - name: desktop-profile accessLevel: ALL - name: desktop-layout accessLevel: NONE resourceCount: 2 createdTime: 0 lastUpdatedTime: 0 properties: organizationId: type: string format: uuid description: ID of the contact center organization. This field is required for all bulk save operations. example: f53c8b54-46ca-43f6-ba05-08426a46e23d maxLength: 36 minLength: 32 pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$ id: type: string description: ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource. example: 93912f11-6017-404b-bf14-5331890b1797 version: type: integer format: int32 description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise. example: 1 name: type: string description: The name of the user profile. example: Contact Center Admin Profile maxLength: 80 minLength: 0 pattern: ^[a-zA-Z0-9,_\-\s]*$ description: type: string description: An optional description of the profile. example: This profile should be applied only to contact center admins. maxLength: 255 minLength: 0 profileType: type: string description: "The type determines the privileges applicable for a profile.\n\nIt can take one of these values:\n\nSTANDARD_AGENT — Has access to Agent Desktop[m_agent_desktop] module.\n\nPREMIUM_AGENT — Has access to Agent Desktop[m_agent_desktop] and Multimedia[m_multimedia] module.\n\nSUPERVISOR — Has access to all modules except to manage tenants in the Provisioning[m_provisioning] module.\n\nADMINISTRATOR — Has access to all modules.\n\nADMINISTRATOR_ONLY — Has access to Provisioning[m_provisioning], Real Time Reports[m_real_time_reports], Call Recording[m_call_recording], IMI Digital Channels[m_imi_digital_channels], and Routing Strategy[m_routing_strategy] modules.\n\nIt is required only during a create operation. \n\nThe profile type cannot be changed for an existing user profile.\n\n" enum: - ADMINISTRATOR - ADMINISTRATOR_ONLY - SUPERVISOR - PREMIUM_AGENT - STANDARD_AGENT - ANALYZER_ADMINISTRATOR - ANALYZER_SUPERVISOR - ANALYZER_USER example: PREMIUM_AGENT active: type: boolean description: Specify whether the User profile is active or not. example: true permissionAccessLevel: type: string description: 'This can be used to allow users of this profile access to specific or all the Webex Contact Center permissions. It can take one of these values: ALL — A contact center user with this profile can access all Contact Center permissions. SPECIFIC — A contact center user with this profile can access only specific permissions. ' enum: - SPECIFIC - ALL - PROVISIONED_VALUE - NONE example: ALL resourceAccessLevel: type: string description: 'This can be used to allow users of this profile access to specific or all the Webex Contact Center resources. It can take one of these values: ALL — A contact center user with this profile can access all Contact Center resources. SPECIFIC — A contact center user with this profile can access only specific resources. ' enum: - SPECIFIC - ALL - PROVISIONED_VALUE - NONE example: ALL permissions: type: array description: 'Specifies the permissions(s) a user of this profile has access to. It should be chosen when permission access is SPECIFIC. Please specify all the following permissions and their respective access type. ' items: $ref: '#/components/schemas/UserProfilePermissionsDTO' uniqueItems: true editableFolderIds: type: array description: "Indicates the id(s) of the reporting folders a user of this profile has read and write access to. \n" example: - 1 - 2 items: type: integer format: int32 uniqueItems: true viewableFolderIds: type: array description: "Indicates the id(s) of the reporting folders a user of this profile has read access to. \n" example: - 1 - 2 items: type: integer format: int32 uniqueItems: true nonViewableFolderIds: type: array description: "Indicates the id(s) of the restricted reporting folders for a user of this profile. \n" example: - 1 - 2 items: type: integer format: int32 uniqueItems: true systemDefault: type: boolean description: Indicates whether the created resource is system created or not example: false defaultResourceCollectionId: type: string description: Specifies the default resource collection for this profile example: 80f49a6e-11d7-4651-b730-99ed2f726f61 resourceCollections: type: array description: 'Specifies the resource collection(s) a user of this profile has access to. resource collection(s) needs to be specified when resourceAccessLevel is SPECIFIC' items: $ref: '#/components/schemas/ResourceCollectionDTO' uniqueItems: true createdTime: type: integer format: int64 description: This is the created time of the entity. lastUpdatedTime: type: integer format: int64 description: This is the updated time of the entity. required: - active - name - permissionAccessLevel - profileType - resourceAccessLevel UserDetailsResponseEnvelopeDTO: type: object description: The response envelope for user details operations. properties: meta: type: object additionalProperties: {} description: Metadata of response with paging information. Includes orgId, page, pageSize, totalPages, totalRecords, and pagination links. example: orgid: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1 page: 1 pageSize: 100 totalPages: 3 totalRecords: 300 links: next: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/user/fetch-user-details-by-ids?page=2&pageSize=100 last: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/user/fetch-user-details-by-ids?page=2&pageSize=100 prev: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/user/fetch-user-details-by-ids?page=0&pageSize=100 self: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/user/fetch-user-details-by-ids?page=1&pageSize=100 first: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/user/fetch-user-details-by-ids?page=0&pageSize=100 data: type: array items: $ref: '#/components/schemas/UserDetailsResponseDTO' description: The response data payload containing user details. AssignedDynamicSkillsDTO: type: object properties: organizationId: type: string format: uuid description: ID of the contact center organization. This field is required for all bulk save operations. example: f53c8b54-46ca-43f6-ba05-08426a46e23d maxLength: 36 minLength: 32 pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$ id: type: string description: ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource. example: 93912f11-6017-404b-bf14-5331890b1797 version: type: integer format: int32 description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise. example: 1 skillId: type: string description: The ID of the skill. example: skill456 minLength: 1 textValue: type: string description: A short textual description that represents a skill the agent has. example: Credit card SME maxLength: 100 minLength: 0 booleanValue: type: boolean description: Indicates whether the agent has this skill (True) or does not have the skill (False). example: true proficiencyValue: type: integer format: int32 description: A number between 0 and 10 to indicate how proficient the agent is in this skill. example: 5 maximum: 10 minimum: 0 enumSkillValues: type: string description: Indicates a value that represents a skill the agent has. example: FRENCH skillName: type: string createdTime: type: integer format: int64 description: This is the created time of the entity. lastUpdatedTime: type: integer format: int64 description: This is the updated time of the entity. required: - skillId BulkRequestDTOUserDTO: type: object description: The request body for bulk user operations. properties: items: type: array description: List of items in the bulk request. items: $ref: '#/components/schemas/BulkRequestItemDTOUserDTO' PaginationLinks: type: object properties: self: type: string description: Link to the current page. example: /v1/callbacks/organization/${orgId}/scheduled-callback?page=1&pageSize=10 first: type: string description: Link to the first page. example: /v1/callbacks/organization/${orgId}/scheduled-callback?page=0&pageSize=10 last: type: string description: Link to the last page. example: /v1/callbacks/organization/${orgId}/scheduled-callback?page=4&pageSize=10 next: type: string description: Link to the next page. example: /v1/callbacks/organization/${orgId}/scheduled-callback?page=2&pageSize=10 prev: type: string description: Link to the previous page. example: /v1/callbacks/organization/${orgId}/scheduled-callback?page=0&pageSize=10 required: - self QueueSkillRequirementDTO: type: object description: Skill requirement for the queue properties: organizationId: type: string format: uuid description: ID of the contact center organization. This field is required for all bulk save operations. example: f53c8b54-46ca-43f6-ba05-08426a46e23d maxLength: 36 minLength: 32 pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$ id: type: string description: ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource. example: 93912f11-6017-404b-bf14-5331890b1797 version: type: integer format: int32 description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise. example: 1 skillId: type: string description: Skill ID reference example: af9eecc5-0472-4549-9a83-2afdae0d4ba0 minLength: 1 skillName: type: string description: Indicates the name of the skill. Once created, name cannot be modified. example: German Speaking skillType: type: string description: 'This can be of the following types PROFICIENCY: id = 0 BOOLEAN: id = 1 TEXT: id = 2 ENUM: id = 3 Once created, skillType cannot be modified. ' example: BOOLEAN condition: type: string description: Indicates a value that represents a skill the agent has. example: IS_NOT skillValue: type: string description: A short textual description that represents a skill the agent has. example: Credit card SME minLength: 1 weight: type: integer format: int32 description: Weight for proficiency skill requirement example: 100 maximum: 1000 dynamicSkill: type: boolean description: Indicates whether the skill is a dynamic skill or not. Default value is false. example: false createdTime: type: integer format: int64 description: This is the created time of the entity. lastUpdatedTime: type: integer format: int64 description: This is the updated time of the entity. required: - condition - skillId - skillValue EntityInfo: type: object properties: id: type: string description: id example: id. name: type: string description: name example: name. additionalAttributes: type: object additionalProperties: type: string description: A map containing additional attributes of entity where both the key and value are Strings. example: '{"key1":"value1","key2":"value2"}' description: A map containing additional attributes of entity where both the key and value are Strings. example: key1: value1 key2: value2 createdDate: type: string lastModifiedDate: type: string version: type: integer format: int32 ResourceCollectionDTO_UserResponseWithUserProfileGranularAccess: type: object description: A collection of resources with their types and access levels. example: id: 80f49a6e-11d7-4651-b730-99ed2f726f61 name: Department1 description: Department1 description. resources: - name: team accessLevel: SPECIFIC ids: - 00734874-4732-43bb-bfff-d1e75d309eb1 - 00734874-4732-43bb-bfff-d1e75d309eb2 - name: desktop-profile accessLevel: ALL - name: desktop-layout accessLevel: NONE resourceCount: 2 properties: organizationId: type: string format: uuid description: ID of the contact center organization. This field is required for all bulk save operations. example: f53c8b54-46ca-43f6-ba05-08426a46e23d maxLength: 36 minLength: 32 pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$ id: type: string description: ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource. example: 93912f11-6017-404b-bf14-5331890b1797 version: type: integer format: int32 description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise. example: 1 name: type: string description: The name of the resource collection. example: Department1 maxLength: 80 minLength: 1 pattern: ^[a-zA-Z\d-_\s]+$ description: type: string description: An optional description of the resource collection. example: Department1 description. maxLength: 255 minLength: 0 resources: type: array description: The name of the resource and Type of resource list. items: $ref: '#/components/schemas/ResourceTypesDTO_UserResponseWithUserProfileGranularAccess' uniqueItems: true resourceCount: type: integer format: int64 description: The total count of resources in this collection example: 2 createdTime: type: integer format: int64 description: This is the created time of the entity. lastUpdatedTime: type: integer format: int64 description: This is the updated time of the entity. required: - name UserProfileAppModuleDTO: type: object description: User Profile App Module DTO properties: organizationId: type: string format: uuid description: ID of the contact center organization. This field is required for all bulk save operations. example: f53c8b54-46ca-43f6-ba05-08426a46e23d maxLength: 36 minLength: 32 pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$ id: type: string description: ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource. example: 93912f11-6017-404b-bf14-5331890b1797 version: type: integer format: int32 description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise. example: 1 appModuleId: type: string description: "The code of a Webex Contact Center module. \n\nPlease specify descriptions for each of these modules:\n\nm_provisioning - Refers to the provisioning module. Has access to Manage EntryPoints and Queues[f_manage_entrypt_queue], Revoke API Key[f_revoke_api_key], DN Mappings[f_dn_mappings], Manage User Profiles[f_manage_user_profiles], Manage Tenants[f_manage_tenants], Manage Users[f_manage_users], Portal Branding[f_portal_branding], Audit Trail[f_audit_trail], Manage Sites[f_manage_sites], Manage Teams[f_manage_teams], and Manage Dial Plans[f_manage_dial_plans] features.\n\nm_real_time_reports - Refers to the real time reporting module. Has access to Summary View[f_summary_view], Agent State Change[f_agent_state_change], Real Time Threshold Alerts[f_realtime_threshold_alerts], and Web CallBack Report[f_web_callback_report] features.\n\nm_historical_reports - Refers to the historical reporting module.\n\nm_routing_strategy - Refers to the routing strategy module. Has access to Manage Media Files[f_manage_media_files] and Manage Call Flow Scripts[f_manage_call_flow_scripts] features.\n\nm_call_recording - Refers to the call recording module.\n\nm_call_monitoring - Refers to the call monitoring module. Has access to Barge In[f_barge_in], View Blind Monitor Request[f_view_blind_monitor_requests], Whisper Coach[f_whisper_coach], Mid Call Monitor[f_mid_call_monitor], and Restricted Monitor[f_restricted_monitor_only] features.\n\nm_reporting_analytics - Refers to the reporting analytics module. Has access to Analyzer Data Exchange[f_analyzer_data_exchange] and Business Rules[f_business_rules] features. \n\nm_recording_management - Refers to the recording management module. Has access to Tags[f_tags], Security Keys[f_security_keys], Manage Recordings[f_manage_recordings], and Custom Attributes[f_custom_attributes] features.\n\nm_agent_desktop - Refers to the agent desktop module.\n\nm_logout_agents - Refers to the agent logout module.\n\nm_manage_agent_states - Refers to the agent state module. Has access to Sign Out Agent[f_sign_out_agent] and Change Agent State[f_change_agent_state] features.\n\nm_additional_supervisory_features - Refers to the additional supervisory features module. Has access to Sign Out Agents[f_sign_out_agents], Change Agent States[f_change_agent_states] and Send Messages[f_send_messages] features.\n\nm_multimedia - Refers to the multimedia module. Has access to Provisioning[f_mm_provisioning], Basic Digital[f_mm_basic_digital], Social Channel[f_mm_social_channel] and Agent Desktop[f_mm_agent_desktop] features.\n\nm_agent_wellbeing - Refers to the Agent Wellbeing module. Has access to Agent Wellbeing provisioning features.\n\nm_auto_csat - Refers to the Auto Csat module.\n\nm_generated_summaries - Refers to the Generated Summaries module.\n\nm_agent_personal_greetings - Refers to the Agent Personal Greetings module.\n\nm_functions - Refers to the Functions in flow module.\n\nm_realtime_transcripts - Refers to the Realtime Transcripts module.\n\nm_suggested_responses - Refers to the Suggested Responses module.\n" example: m_provisioning minLength: 1 moduleAccessType: type: string description: 'Indicates the access rights for a user of this profile for a Webex Contact Center module. It can take be one of these values: VIEW — A contact center user with this profile has read only access to a Contact Center module. EDIT — A contact center user with this profile has read and write access to a Contact Center module. NONE — A contact center user with this profile cannot access the module. ' enum: - NONE - VIEW - EDIT example: EDIT userProfileAppFeature: type: array description: "Specifies the module features(s) a user of this profile has access to. \n" items: $ref: '#/components/schemas/UserProfileAppFeatureDTO' uniqueItems: true createdTime: type: integer format: int64 description: This is the created time of the entity. lastUpdatedTime: type: integer format: int64 description: This is the updated time of the entity. required: - appModuleId - moduleAccessType ResponseEnvelopeUserDynamicSkillResponseDTO: type: object description: The response envelope for user dynamic skill operations. properties: meta: type: object additionalProperties: {} description: Metadata information for the response. data: type: array items: $ref: '#/components/schemas/UserDynamicSkillResponseDTO' description: The response data payload. DynamicSkills: type: object properties: add: type: array items: $ref: '#/components/schemas/UpdateDynamicSkillsDTO' description: The list of dynamic skills to add. remove: type: array items: type: string description: A dynamic skill identifier to remove. description: The list of dynamic skills to remove. UserResponseDTO: type: object description: The response object representing a user in the contact center. properties: organizationId: type: string format: uuid description: ID of the contact center organization. This field is required for all bulk save operations. example: f53c8b54-46ca-43f6-ba05-08426a46e23d maxLength: 36 minLength: 32 pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$ id: type: string description: ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource. example: 93912f11-6017-404b-bf14-5331890b1797 version: type: integer format: int32 description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise. example: 1 firstName: type: string description: The first name of the user. example: John lastName: type: string description: The last name of the user. example: Wick email: type: string description: The email address of the user. example: johnwick@company.com workPhone: type: string description: The work phone number of the user. example: '1234567890' mobile: type: string description: The mobile phone number of the user. example: '1234567890' ciUserId: type: string description: Cisco Common Identity user Id example: 1dq21e23-1234-5578-9a83-2afdae0d4ba1 broadCloudUserId: type: string description: Broadcloud user Id example: 1dq21e23-1234-5578-9a83-2afdae0d4ba1 timezone: type: string description: (Optional) The time zone that you provision for your enterprise. example: America/New_York xspVersion: type: string description: (Optional) Used to subscribe for recording events. example: xsp-24.0 subscriptionId: type: string description: (Optional) Used to subscribe for recording events. example: 04d0bdf6-6d6a-4aae-8a8a-71c9152e6478 userProfileId: type: string description: Identifier for an user profile which a Contact Center administrator has configured. example: 1dq21e23-1234-5578-9a83-2afdae0d4ba1 userProfileType: type: string description: Type of the user profile associated to this user. This is an optional response parameter based on the query parameter includeUserProfileType. example: PREMIUM_AGENT contactCenterEnabled: type: boolean description: The setting is for accessing Desktop to handle customer requests. example: true siteId: type: string description: Details of site which a Contact Center administrator has configured for the user. example: 1dq21e23-1234-5578-9a83-2afdae0d4ba1 siteName: type: string description: site name that user is associated with example: bengaluru teamIds: type: array description: "Specify the teams id which got assigned to this user. \nNote: You can’t assign this profile to a capacity-based team." example: - f53c8b54-46ca-43f6-ba05-08426a46e23d - a53c8b54-46ca-43f6-ba05-08426a46e23f items: type: string description: "Specify the teams id which got assigned to this user. \nNote: You can’t assign this profile to a capacity-based team." example: f53c8b54-46ca-43f6-ba05-08426a46e23d uniqueItems: true skillProfileId: type: string description: '(Optional) If your enterprise uses the optional Skills-Based Routing feature, This profile overrides any skill profile at the team level that is associated with the agent ' example: f53c8b54-46ca-43f6-ba05-08426a46e23d agentProfileId: type: string description: Identifier for a Desktop Profile which is a group of permissions and Agent Desktop behaviors that you assign to specific users. example: 8e6bb6da-2a78-4768-bef9-7e229f92af22 multimediaProfileId: type: string description: (Optional) If your organization administrator enables Multimedia for your enterprise, you can select a multimedia profile for this team. example: f53c8b54-46ca-43f6-ba05-08426a46e23d deafultDialledNumber: type: string description: (Optional) The dial number of the agent. example: '1234567890' externalIdentifier: type: string description: (Optional) Agent identification details, such as the employee number. example: '121212' active: type: boolean description: Specify whether the user is active or not active. example: true dbId: type: string description: Legacy identifier for migrated users. example: 1dq45f23-1234-6r18-9a83-2atuiy0d4bh1 userProfileData: $ref: '#/components/schemas/UserProfileDTO' description: Details of UserProfile which a Contact Center administrator has configured for the user.This is an optional object, returned only when the endpoint 'Get User along with profile by ID' is invoked. userProfileGranularAccessData: $ref: '#/components/schemas/UserProfileGranularAccessDTO' description: Details of UserProfile which a Contact Center administrator has configured for the user.This is an optional object, returned only when the endpoint 'Get User along with profile by ID' is invoked. imiUserCreated: type: boolean description: Specify whether or not the corresponding user is created in IMI. example: true preferredSupervisorTeamId: type: string description: The teamId to look for to load the desktop layout when a supervisor logs in to desktop. example: e27d2b54-46ca-43g6-ba65-08426e46e23d systemDefault: type: boolean description: Indicates whether the created resource is system created or not example: false userLevelBurnoutInclusion: type: string description: 'User level burnout inclusion type. Used only when Agent inclusion is set to ''Specific Agents'' at the org level Agent Wellbeing>Burnout config. ' enum: - INCLUDED - EXCLUDED example: INCLUDED userLevelAutoCSATInclusion: type: string description: 'User level AutoCSAT inclusion type. Used only when Agent inclusion is set to ''Specific Agents'' at the org level Cisco AI Assistant>Auto CSAT config. ' enum: - INCLUDED - EXCLUDED example: INCLUDED userLevelWellnessBreakReminders: type: string description: 'User level Wellness break reminder type. If top level Agent burnout config has wellness break reminders enabled, this property determines if an Agent is enabled/disabled for receiving break reminders. ' enum: - DISABLED - ENABLED example: DISABLED userLevelSummariesInclusion: type: string description: 'User level Generated Summaries inclusion type. Used only when Generated Summaries is set to ''Specific Agents'' at the org level Cisco AI Assistant>Generated Summaries. ' enum: - INCLUDED - EXCLUDED example: INCLUDED queuesCount: $ref: '#/components/schemas/QueuesCountDTO' description: 'The count of each type of Contact Service Queues that the user is assigned to. ' example: "{\n \"teamBased\": 0\n \"skillBased\": 0\n \"agentBased\": 0\n}" skillProfileUpdatedBy: type: string description: The ID of the user who last modified the skill profile example: 1dq21e23-1234-5578-9a83-2afdae0d4ba1 dynamicSkills: type: array description: The list of dynamic skills associated with the user items: $ref: '#/components/schemas/AssignedDynamicSkillsDTO' dynamicSkillsLimitReached: type: boolean description: Indicates if the user has reached the dynamic skills assignment limit. Present only if includeDynamicSkillsLimitReached=true is passed in the request. example: true dynamicSkillsUpdatedBy: type: string description: The name of the user who last modified dynamic skills dynamicSkillsUpdatedTime: type: integer format: int64 description: The date when dynamic skills were last modified example: 1679393400000 dynamicSkillAssigned: type: boolean description: Indicates if the user has the specified dynamic skill assigned. Present only if checkIfUserHasDynamicSkill=true and dynamicSkillId are provided in the request. example: true createdTime: type: integer format: int64 description: This is the created time of the entity. lastUpdatedTime: type: integer format: int64 description: This is the updated time of the entity. skillProfileUpdatedTime: type: integer format: int64 description: The date when the skill profile was last modified example: 1679393400000 BulkResponseItemDTO: type: object properties: itemIdentifier: type: integer description: Unique item identifier for a bulk operation. format: int32 example: 10 status: type: integer description: Indicates the error status code. format: int32 example: 400 operationType: type: string description: The kind of operation desired of an entity. example: CREATE enum: - CREATE - UPDATE - DELETE - GET href: type: string description: The resource URI of an entity. example: /api/organization/6705c69d-4585-42ad-bfc3-79cc485dfb15/team/7b26d174-0016-4682-9858-65918e05f85 apiError: $ref: '#/components/schemas/ApiErrorResponse' example: apiError: error: key: '400' message: - description: 'siteId: not found for given orgId.' entity: string references: - id: string name: string reason: dependency exists trackingId: ccconfig_c1a4fcef-aee2-4dea-8977-29f594760552 href: /api/organization/6705c69d-4585-42ad-bfc3-79cc485dfb15/team/7b26d174-0016-4682-9858-65918e05f85 itemIdentifier: 10 operationType: CREATE status: 400 BulkRequestDTOUpdateDynamicSkillsDTO: type: object description: The request body for bulk dynamic skills update operations. properties: items: type: array description: List of items in the bulk request. items: $ref: '#/components/schemas/BulkRequestItemDTOUpdateDynamicSkillsDTO' OperationError: description: An error message providing details about the operation failure. type: object properties: description: type: string description: A human readable explanation for the occurrence of an error. example: Incorrect Credentials. UserWithSkillDetailsDTO: type: object description: The user details including skill information. properties: organizationId: type: string format: uuid description: ID of the contact center organization. This field is required for all bulk save operations. example: f53c8b54-46ca-43f6-ba05-08426a46e23d maxLength: 36 minLength: 32 pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$ id: type: string description: ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource. example: 93912f11-6017-404b-bf14-5331890b1797 version: type: integer format: int32 description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise. example: 1 firstName: type: string description: The first name of the user. Can be changed using Users Management in Cisco Webex Control Hub. example: John1 lastName: type: string description: The last name of the user. Can be changed using Users Management in Cisco Webex Control Hub. example: Wick1 email: type: string description: The email address of the user. Can be changed using Users Management in Cisco Webex Control Hub. example: johnwick1@company.com skillProfileName: type: string description: The skillProfileName of the user. example: skillprofileName createdTime: type: integer format: int64 description: This is the created time of the entity. lastUpdatedTime: type: integer format: int64 description: This is the updated time of the entity. JsonValue: type: object properties: valueType: type: string enum: - ARRAY - OBJECT - STRING - NUMBER - 'TRUE' - 'FALSE' - 'NULL' description: The type of the JSON value. UserDetailsResponseDTO: type: object description: The response object containing detailed user information. properties: id: type: string description: Unique ID of the user example: 123e4567-e89b-12d3-a456-426614174000 firstName: type: string description: First name of the user example: John lastName: type: string description: Last name of the user example: Doe email: type: string description: Email address of the user example: john.doe@example.com UserResponseDTO_UserResponseWithUserProfileGranularAccess: type: object description: The response object representing a user with user profile and granular access details. properties: organizationId: type: string format: uuid description: ID of the contact center organization. This field is required for all bulk save operations. example: f53c8b54-46ca-43f6-ba05-08426a46e23d maxLength: 36 minLength: 32 pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$ id: type: string description: ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource. example: 93912f11-6017-404b-bf14-5331890b1797 version: type: integer format: int32 description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise. example: 1 firstName: type: string description: The first name of the user. example: John lastName: type: string description: The last name of the user. example: Wick email: type: string description: The email address of the user. example: johnwick@company.com workPhone: type: string description: The work phone number of the user. example: '1234567890' mobile: type: string description: The mobile phone number of the user. example: '1234567890' ciUserId: type: string description: Cisco Common Identity user Id example: 1dq21e23-1234-5578-9a83-2afdae0d4ba1 broadCloudUserId: type: string description: Broadcloud user Id example: 1dq21e23-1234-5578-9a83-2afdae0d4ba1 timezone: type: string description: (Optional) The time zone that you provision for your enterprise. example: America/New_York xspVersion: type: string description: (Optional) Used to subscribe for recording events. example: xsp-24.0 subscriptionId: type: string description: (Optional) Used to subscribe for recording events. example: 04d0bdf6-6d6a-4aae-8a8a-71c9152e6478 userProfileId: type: string description: Identifier for an user profile which a Contact Center administrator has configured. example: 1dq21e23-1234-5578-9a83-2afdae0d4ba1 userProfileType: type: string description: Type of the user profile associated to this user. This is an optional response parameter based on the query parameter includeUserProfileType. example: PREMIUM_AGENT contactCenterEnabled: type: boolean description: The setting is for accessing Desktop to handle customer requests. example: true siteId: type: string description: Details of site which a Contact Center administrator has configured for the user. example: 1dq21e23-1234-5578-9a83-2afdae0d4ba1 siteName: type: string description: site name that user is associated with example: bengaluru teamIds: type: array description: "Specify the teams id which got assigned to this user. \nNote: You can’t assign this profile to a capacity-based team." example: - f53c8b54-46ca-43f6-ba05-08426a46e23d - a53c8b54-46ca-43f6-ba05-08426a46e23f items: type: string description: "Specify the teams id which got assigned to this user. \nNote: You can’t assign this profile to a capacity-based team." example: f53c8b54-46ca-43f6-ba05-08426a46e23d uniqueItems: true skillProfileId: type: string description: '(Optional) If your enterprise uses the optional Skills-Based Routing feature, This profile overrides any skill profile at the team level that is associated with the agent ' example: f53c8b54-46ca-43f6-ba05-08426a46e23d agentProfileId: type: string description: Identifier for a Desktop Profile which is a group of permissions and Agent Desktop behaviors that you assign to specific users. example: 8e6bb6da-2a78-4768-bef9-7e229f92af22 multimediaProfileId: type: string description: (Optional) If your organization administrator enables Multimedia for your enterprise, you can select a multimedia profile for this team. example: f53c8b54-46ca-43f6-ba05-08426a46e23d deafultDialledNumber: type: string description: (Optional) The dial number of the agent. example: '1234567890' externalIdentifier: type: string description: (Optional) Agent identification details, such as the employee number. example: '121212' active: type: boolean description: Specify whether the user is active or not active. example: true dbId: type: string description: Legacy identifier for migrated users. example: 1dq45f23-1234-6r18-9a83-2atuiy0d4bh1 userProfileGranularAccessData: $ref: '#/components/schemas/UserProfileGranularAccessDTO_UserResponseWithUserProfileGranularAccess' description: Details of UserProfile which a Contact Center administrator has configured for the user.This is an optional object, returned only when the endpoint 'Get User along with profile by ID' is invoked. imiUserCreated: type: boolean description: Specify whether or not the corresponding user is created in IMI. example: true preferredSupervisorTeamId: type: string description: The teamId to look for to load the desktop layout when a supervisor logs in to desktop. example: e27d2b54-46ca-43g6-ba65-08426e46e23d systemDefault: type: boolean description: Indicates whether the created resource is system created or not example: false userLevelBurnoutInclusion: type: string description: 'User level burnout inclusion type. Used only when Agent inclusion is set to ''Specific Agents'' at the org level Agent Wellbeing>Burnout config. ' enum: - INCLUDED - EXCLUDED example: INCLUDED userLevelAutoCSATInclusion: type: string description: 'User level AutoCSAT inclusion type. Used only when Agent inclusion is set to ''Specific Agents'' at the org level Cisco AI Assistant>Auto CSAT config. ' enum: - INCLUDED - EXCLUDED example: INCLUDED userLevelWellnessBreakReminders: type: string description: 'User level Wellness break reminder type. If top level Agent burnout config has wellness break reminders enabled, this property determines if an Agent is enabled/disabled for receiving break reminders. ' enum: - DISABLED - ENABLED example: DISABLED userLevelSummariesInclusion: type: string description: 'User level Generated Summaries inclusion type. Used only when Generated Summaries is set to ''Specific Agents'' at the org level Cisco AI Assistant>Generated Summaries. ' enum: - INCLUDED - EXCLUDED example: INCLUDED queuesCount: $ref: '#/components/schemas/QueuesCountDTO_UserResponseWithUserProfileGranularAccess' description: 'The count of each type of Contact Service Queues that the user is assigned to. ' example: "{\n \"teamBased\": 0\n \"skillBased\": 0\n \"agentBased\": 0\n}" skillProfileUpdatedBy: type: string description: The ID of the user who last modified the skill profile example: 1dq21e23-1234-5578-9a83-2afdae0d4ba1 dynamicSkills: type: array description: The list of dynamic skills associated with the user items: $ref: '#/components/schemas/AssignedDynamicSkillsDTO_UserResponseWithUserProfileGranularAccess' dynamicSkillsLimitReached: type: boolean description: Indicates if the user has reached the dynamic skills assignment limit. Present only if includeDynamicSkillsLimitReached=true is passed in the request. example: true dynamicSkillsUpdatedBy: type: string description: The name of the user who last modified dynamic skills dynamicSkillsUpdatedTime: type: integer format: int64 description: The date when dynamic skills were last modified example: 1679393400000 dynamicSkillAssigned: type: boolean description: Indicates if the user has the specified dynamic skill assigned. Present only if checkIfUserHasDynamicSkill=true and dynamicSkillId are provided in the request. example: true createdTime: type: integer format: int64 description: This is the created time of the entity. lastUpdatedTime: type: integer format: int64 description: This is the updated time of the entity. skillProfileUpdatedTime: type: integer format: int64 description: The date when the skill profile was last modified example: 1679393400000 AssignedDynamicSkillsDTO_UserResponseWithUserProfile: type: object description: The list of dynamic skills associated with the user properties: organizationId: type: string format: uuid description: ID of the contact center organization. This field is required for all bulk save operations. example: f53c8b54-46ca-43f6-ba05-08426a46e23d maxLength: 36 minLength: 32 pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$ id: type: string description: ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource. example: 93912f11-6017-404b-bf14-5331890b1797 version: type: integer format: int32 description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise. example: 1 skillId: type: string description: The ID of the skill. example: skill456 minLength: 1 textValue: type: string description: A short textual description that represents a skill the agent has. example: Credit card SME maxLength: 100 minLength: 0 booleanValue: type: boolean description: Indicates whether the agent has this skill (True) or does not have the skill (False). example: true proficiencyValue: type: integer format: int32 description: A number between 0 and 10 to indicate how proficient the agent is in this skill. example: 5 maximum: 10 minimum: 0 enumSkillValues: type: string description: Indicates a value that represents a skill the agent has. example: FRENCH skillName: type: string description: The name of the dynamic skill. createdTime: type: integer format: int64 description: This is the created time of the entity. lastUpdatedTime: type: integer format: int64 description: This is the updated time of the entity. required: - skillId ErrorDetails: description: Details of an error. type: object properties: key: type: string description: An application defined error code. example: '401' message: type: array description: A message providing details about the error. items: $ref: '#/components/schemas/OperationError' QueuesCountDTO_UserResponseWithUserProfile: type: object description: 'The count of each type of Contact Service Queues that the user is assigned to. ' example: teamBased: 0 skillBased: 0 agentBased: 0 properties: teamBased: type: integer format: int32 description: The count of team-based queues. skillBased: type: integer format: int32 description: The count of skill-based queues. agentBased: type: integer format: int32 description: The count of agent-based queues. MetaDataPagedUser: type: object properties: orgid: type: string description: ID of the contact center organization. This field is required for all bulk save operations. example: af9eecc5-0472-4549-9a83-2afdae0d4ba0 page: type: integer format: int32 description: Current page number. example: 1 pageSize: type: integer format: int32 description: Page size for current data set. example: 20 totalPages: type: integer format: int32 description: Number of pages. example: 5 totalRecords: type: integer format: int64 description: Total number of items. example: 100 links: type: object $ref: '#/components/schemas/PaginationLinks' additionalProperties: type: string actualBurnoutInclusionCount: type: integer format: int64 description: Indicates the actual count of Agents selected for Agent burnout detection, including restricted agents that are not visible to requesting user. example: 100 actualAutoCSATCount: type: integer format: int64 description: Indicates the actual count of Agents selected for Auto CSAT scores, including restricted agents that are not visible to requesting user. example: 100 actualSummariesCount: type: integer format: int64 description: Indicates the actual count of Agents selected for Generated Summaries, including restricted agents that are not visible to requesting user. example: 100 BulkRequestItemDTOUserDTO: type: object description: List of items in the bulk request. properties: itemIdentifier: type: integer format: int32 description: Unique item identifier for a bulk operation. example: 10 item: $ref: '#/components/schemas/UserDTO' requestAction: type: string description: Identifier for action type. Possible values are `SAVE` and `DELETE`. example: SAVE UserDetailsRequestDTO: type: object description: Get User Details by list of user ids payload properties: userIds: type: array items: example: a1b2c3d4-e5f6-7g8h-9i10-j11k12l13m14 description: A user identifier. description: The list of user identifiers to retrieve details for. search: type: string description: 'Text used to search for users (e.g., by firstName, lastName or email of the user). If provided, `queueId` is **required**. Cannot be used in combination with `userIds`. ' example: john queueId: type: string description: 'Agent Based Queue ID to filter users . Required if `search` is provided. Cannot be used with `userIds`. ' example: c0ffee12-3456-abcd-7890-deadbeef1234 BulkResponseDTO: type: object properties: items: type: array items: $ref: '#/components/schemas/BulkResponseItemDTO' UserProfileGranularAccessDTO_UserResponseWithUserProfileGranularAccess: type: object description: Data Transfer Object for creating or updating a user profile with granular access controls. example: organizationId: f53c8b54-46ca-43f6-ba05-08426a46e23d id: 93912f11-6017-404b-bf14-5331890b1797 version: 1 name: Contact Center Admin Profile description: This profile should be applied only to contact center admins. profileType: PREMIUM_AGENT active: true permissionAccessLevel: ALL resourceAccessLevel: ALL permissions: - id: 00734874-4732-43bb-bfff-d1e75d309eb1 name: sites access: NONE editableFolderIds: - 1 - 2 viewableFolderIds: - 1 - 2 nonViewableFolderIds: - 1 - 2 systemDefault: false defaultResourceCollectionId: 80f49a6e-11d7-4651-b730-99ed2f726f61 resourceCollections: - id: 80f49a6e-11d7-4651-b730-99ed2f726f61 name: Department1 description: Department1 description. resources: - name: team accessLevel: SPECIFIC ids: - 00734874-4732-43bb-bfff-d1e75d309eb1 - 00734874-4732-43bb-bfff-d1e75d309eb2 - name: desktop-profile accessLevel: ALL - name: desktop-layout accessLevel: NONE resourceCount: 2 createdTime: 0 lastUpdatedTime: 0 properties: organizationId: type: string format: uuid description: ID of the contact center organization. This field is required for all bulk save operations. example: f53c8b54-46ca-43f6-ba05-08426a46e23d maxLength: 36 minLength: 32 pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$ id: type: string description: ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource. example: 93912f11-6017-404b-bf14-5331890b1797 version: type: integer format: int32 description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise. example: 1 name: type: string description: The name of the user profile. example: Contact Center Admin Profile maxLength: 80 minLength: 0 pattern: ^[a-zA-Z0-9,_\-\s]*$ description: type: string description: An optional description of the profile. example: This profile should be applied only to contact center admins. maxLength: 255 minLength: 0 profileType: type: string description: "The type determines the privileges applicable for a profile.\n\nIt can take one of these values:\n\nSTANDARD_AGENT — Has access to Agent Desktop[m_agent_desktop] module.\n\nPREMIUM_AGENT — Has access to Agent Desktop[m_agent_desktop] and Multimedia[m_multimedia] module.\n\nSUPERVISOR — Has access to all modules except to manage tenants in the Provisioning[m_provisioning] module.\n\nADMINISTRATOR — Has access to all modules.\n\nADMINISTRATOR_ONLY — Has access to Provisioning[m_provisioning], Real Time Reports[m_real_time_reports], Call Recording[m_call_recording], IMI Digital Channels[m_imi_digital_channels], and Routing Strategy[m_routing_strategy] modules.\n\nIt is required only during a create operation. \n\nThe profile type cannot be changed for an existing user profile.\n\n" enum: - ADMINISTRATOR - ADMINISTRATOR_ONLY - SUPERVISOR - PREMIUM_AGENT - STANDARD_AGENT - ANALYZER_ADMINISTRATOR - ANALYZER_SUPERVISOR - ANALYZER_USER example: PREMIUM_AGENT active: type: boolean description: Specify whether the User profile is active or not. example: true permissionAccessLevel: type: string description: 'This can be used to allow users of this profile access to specific or all the Webex Contact Center permissions. It can take one of these values: ALL — A contact center user with this profile can access all Contact Center permissions. SPECIFIC — A contact center user with this profile can access only specific permissions. ' enum: - SPECIFIC - ALL - PROVISIONED_VALUE - NONE example: ALL resourceAccessLevel: type: string description: 'This can be used to allow users of this profile access to specific or all the Webex Contact Center resources. It can take one of these values: ALL — A contact center user with this profile can access all Contact Center resources. SPECIFIC — A contact center user with this profile can access only specific resources. ' enum: - SPECIFIC - ALL - PROVISIONED_VALUE - NONE example: ALL permissions: type: array description: 'Specifies the permissions(s) a user of this profile has access to. It should be chosen when permission access is SPECIFIC. Please specify all the following permissions and their respective access type. ' items: $ref: '#/components/schemas/UserProfilePermissionsDTO_UserResponseWithUserProfileGranularAccess' uniqueItems: true editableFolderIds: type: array description: "Indicates the id(s) of the reporting folders a user of this profile has read and write access to. \n" example: - 1 - 2 items: type: integer format: int32 uniqueItems: true viewableFolderIds: type: array description: "Indicates the id(s) of the reporting folders a user of this profile has read access to. \n" example: - 1 - 2 items: type: integer format: int32 uniqueItems: true nonViewableFolderIds: type: array description: "Indicates the id(s) of the restricted reporting folders for a user of this profile. \n" example: - 1 - 2 items: type: integer format: int32 uniqueItems: true systemDefault: type: boolean description: Indicates whether the created resource is system created or not example: false defaultResourceCollectionId: type: string description: Specifies the default resource collection for this profile example: 80f49a6e-11d7-4651-b730-99ed2f726f61 resourceCollections: type: array description: 'Specifies the resource collection(s) a user of this profile has access to. resource collection(s) needs to be specified when resourceAccessLevel is SPECIFIC' items: $ref: '#/components/schemas/ResourceCollectionDTO_UserResponseWithUserProfileGranularAccess' uniqueItems: true createdTime: type: integer format: int64 description: This is the created time of the entity. lastUpdatedTime: type: integer format: int64 description: This is the updated time of the entity. required: - active - name - permissionAccessLevel - profileType - resourceAccessLevel QueuesCountDTO_UserResponseWithUserProfileGranularAccess: type: object description: 'The count of each type of Contact Service Queues that the user is assigned to. ' example: teamBased: 0 skillBased: 0 agentBased: 0 properties: teamBased: type: integer format: int32 description: The count of team-based queues assigned to the user. skillBased: type: integer format: int32 description: The count of skill-based queues assigned to the user. agentBased: type: integer format: int32 description: The count of agent-based queues assigned to the user. MetaDataWithPagingInfo: type: object description: Metadata of response with paging information properties: orgid: type: string format: uuid description: Organization ID. example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1 maxLength: 36 minLength: 32 pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$ page: type: integer format: int32 description: Current page number. example: 1 pageSize: type: integer format: int32 description: Page size for current data set. example: 100 totalPages: type: integer format: int32 description: Number of pages. example: 1 totalRecords: type: integer format: int32 description: Total number of items. example: 1000 links: type: object description: Map of pagination links with `self`, `next`, `prev`, `last`, and `first`. example: next: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/entity-name?page=2&pageSize=10 last: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/entity-name?page=3&pageSize=10 prev: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/entity-name?page=0&pageSize=10 self: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/entity-name?page=1&pageSize=10 first: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/entity-name?page=0&pageSize=10 title: MetaDataWithPagingInfo BulkRequestItemDTOUpdateDynamicSkillsDTO: type: object description: List of items in the bulk request. properties: itemIdentifier: type: integer format: int32 description: Unique item identifier for a bulk operation. example: 10 item: $ref: '#/components/schemas/UpdateDynamicSkillsDTO' requestAction: type: string description: Identifier for action type. Possible values are `SAVE` and `DELETE`. example: SAVE UserProfileAppModuleDTO_UserResponseWithUserProfile: type: object description: User Profile App Module DTO properties: organizationId: type: string format: uuid description: ID of the contact center organization. This field is required for all bulk save operations. example: f53c8b54-46ca-43f6-ba05-08426a46e23d maxLength: 36 minLength: 32 pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$ id: type: string description: ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource. example: 93912f11-6017-404b-bf14-5331890b1797 version: type: integer format: int32 description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise. example: 1 appModuleId: type: string description: "The code of a Webex Contact Center module. \n\nPlease specify descriptions for each of these modules:\n\nm_provisioning - Refers to the provisioning module. Has access to Manage EntryPoints and Queues[f_manage_entrypt_queue], Revoke API Key[f_revoke_api_key], DN Mappings[f_dn_mappings], Manage User Profiles[f_manage_user_profiles], Manage Tenants[f_manage_tenants], Manage Users[f_manage_users], Portal Branding[f_portal_branding], Audit Trail[f_audit_trail], Manage Sites[f_manage_sites], Manage Teams[f_manage_teams], and Manage Dial Plans[f_manage_dial_plans] features.\n\nm_real_time_reports - Refers to the real time reporting module. Has access to Summary View[f_summary_view], Agent State Change[f_agent_state_change], Real Time Threshold Alerts[f_realtime_threshold_alerts], and Web CallBack Report[f_web_callback_report] features.\n\nm_historical_reports - Refers to the historical reporting module.\n\nm_routing_strategy - Refers to the routing strategy module. Has access to Manage Media Files[f_manage_media_files] and Manage Call Flow Scripts[f_manage_call_flow_scripts] features.\n\nm_call_recording - Refers to the call recording module.\n\nm_call_monitoring - Refers to the call monitoring module. Has access to Barge In[f_barge_in], View Blind Monitor Request[f_view_blind_monitor_requests], Whisper Coach[f_whisper_coach], Mid Call Monitor[f_mid_call_monitor], and Restricted Monitor[f_restricted_monitor_only] features.\n\nm_reporting_analytics - Refers to the reporting analytics module. Has access to Analyzer Data Exchange[f_analyzer_data_exchange] and Business Rules[f_business_rules] features. \n\nm_recording_management - Refers to the recording management module. Has access to Tags[f_tags], Security Keys[f_security_keys], Manage Recordings[f_manage_recordings], and Custom Attributes[f_custom_attributes] features.\n\nm_agent_desktop - Refers to the agent desktop module.\n\nm_logout_agents - Refers to the agent logout module.\n\nm_manage_agent_states - Refers to the agent state module. Has access to Sign Out Agent[f_sign_out_agent] and Change Agent State[f_change_agent_state] features.\n\nm_additional_supervisory_features - Refers to the additional supervisory features module. Has access to Sign Out Agents[f_sign_out_agents], Change Agent States[f_change_agent_states] and Send Messages[f_send_messages] features.\n\nm_multimedia - Refers to the multimedia module. Has access to Provisioning[f_mm_provisioning], Basic Digital[f_mm_basic_digital], Social Channel[f_mm_social_channel] and Agent Desktop[f_mm_agent_desktop] features.\n\nm_agent_wellbeing - Refers to the Agent Wellbeing module. Has access to Agent Wellbeing provisioning features.\n\nm_auto_csat - Refers to the Auto Csat module.\n\nm_generated_summaries - Refers to the Generated Summaries module.\n\nm_agent_personal_greetings - Refers to the Agent Personal Greetings module.\n\nm_functions - Refers to the Functions in flow module.\n\nm_realtime_transcripts - Refers to the Realtime Transcripts module.\n\nm_suggested_responses - Refers to the Suggested Responses module.\n" example: m_provisioning minLength: 1 moduleAccessType: type: string description: 'Indicates the access rights for a user of this profile for a Webex Contact Center module. It can take be one of these values: VIEW — A contact center user with this profile has read only access to a Contact Center module. EDIT — A contact center user with this profile has read and write access to a Contact Center module. NONE — A contact center user with this profile cannot access the module. ' enum: - NONE - VIEW - EDIT example: EDIT userProfileAppFeature: type: array description: "Specifies the module features(s) a user of this profile has access to. \n" items: $ref: '#/components/schemas/UserProfileAppFeatureDTO_UserResponseWithUserProfile' uniqueItems: true createdTime: type: integer format: int64 description: This is the created time of the entity. lastUpdatedTime: type: integer format: int64 description: This is the updated time of the entity. required: - appModuleId - moduleAccessType UpdateDynamicSkillsDTO: type: object description: The request object for updating dynamic skills for a user. properties: organizationId: type: string format: uuid description: ID of the contact center organization. This field is required for all bulk save operations. example: f53c8b54-46ca-43f6-ba05-08426a46e23d maxLength: 36 minLength: 32 pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$ id: type: string description: ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource. example: 93912f11-6017-404b-bf14-5331890b1797 version: type: integer format: int32 description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise. example: 1 userId: type: string description: The unique identifier of the user. enumSkillValues: type: array items: type: string description: An enum skill value. uniqueItems: true description: The list of enum skill values to assign. textValue: type: string description: The text value of the dynamic skill. booleanValue: type: boolean description: The boolean value of the dynamic skill. proficiencyValue: type: integer format: int32 description: The proficiency value of the dynamic skill. skillId: type: string description: The unique identifier of the skill. createdTime: type: integer format: int64 description: This is the created time of the entity. lastUpdatedTime: type: integer format: int64 description: This is the updated time of the entity. EntityReferenceInfoDTO: type: object properties: description: type: string description: Description about reference info. example: list of referenced entities meta: $ref: '#/components/schemas/MetaDataReferencesPagingInfo' data: type: array items: $ref: '#/components/schemas/EntityInfo' UserProfileDTO: type: object description: Details of UserProfile which a Contact Center administrator has configured for the user.This is an optional object, returned only when the endpoint 'Get User along with profile by ID' is invoked. properties: organizationId: type: string format: uuid description: ID of the contact center organization. This field is required for all bulk save operations. example: f53c8b54-46ca-43f6-ba05-08426a46e23d maxLength: 36 minLength: 32 pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$ id: type: string description: ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource. example: 93912f11-6017-404b-bf14-5331890b1797 version: type: integer format: int32 description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise. example: 1 name: type: string description: The name of the user profile. example: Contact Center Admin Profile maxLength: 80 minLength: 0 pattern: ^[a-zA-Z0-9,_\-\s]*$ description: type: string description: An optional description of the profile. example: This profile should be applied only to contact center admins. maxLength: 255 minLength: 0 profileType: type: string description: "The type determines the privileges applicable for a profile.\n\nIt can take one of these values:\n\nSTANDARD_AGENT — Has access to Agent Desktop[m_agent_desktop] module.\n\nPREMIUM_AGENT — Has access to Agent Desktop[m_agent_desktop] and Multimedia[m_multimedia] module.\n\nSUPERVISOR — Has access to all modules except to manage tenants in the Provisioning[m_provisioning] module.\n\nADMINISTRATOR — Has access to all modules.\n\nADMINISTRATOR_ONLY — Has access to Provisioning[m_provisioning], Real Time Reports[m_real_time_reports], Call Recording[m_call_recording], IMI Digital Channels[m_imi_digital_channels], and Routing Strategy[m_routing_strategy] modules.\n\nIt is required only during a create operation. \n\nThe profile type cannot be changed for an existing user profile.\n\n" enum: - ADMINISTRATOR - ADMINISTRATOR_ONLY - SUPERVISOR - PREMIUM_AGENT - STANDARD_AGENT - ANALYZER_ADMINISTRATOR - ANALYZER_SUPERVISOR - ANALYZER_USER example: PREMIUM_AGENT accessAllModules: type: string description: 'This can be used to allow users of this profile access to specific or all the Webex Contact Center modules. It can take one of these values: ALL — A contact center user with this profile can access all Contact Center modules. SPECIFIC — A contact center user with this profile can access only specific modules. ' enum: - SPECIFIC - ALL - PROVISIONED_VALUE - NONE example: ALL userProfileAppModules: type: array description: 'Specifies the module(s) a user of this profile has access to. It should be chosen when module access is SPECIFIC. Please specify all the following modules and their respective access type. ' items: $ref: '#/components/schemas/UserProfileAppModuleDTO' uniqueItems: true accessAllEntryPoints: type: string description: 'Allow users of this profile access to specific or all the entry points for an organization. It can take one of these values: ALL — A contact center user with this profile can access all the entry points for an organization. SPECIFIC — A contact center user with this profile can access only specific entry points for an organization. ' enum: - SPECIFIC - ALL - PROVISIONED_VALUE - NONE example: ALL accessAllSites: type: string description: 'Allow users of this profile access to specific or all the sites for an organization. It can take one of these values: ALL — A contact center user with this profile can access all the sites for an organization. SPECIFIC — A contact center user with this profile can access only specific sites for an organization. ' enum: - SPECIFIC - ALL - PROVISIONED_VALUE - NONE example: ALL accessAllQueues: type: string description: 'Allow users of this profile access to specific or all the contact center queues for an organization. It can take one of these values: ALL — A contact center user with this profile can access all the contact center queues for an organization. SPECIFIC — A contact center user with this profile can access only specific contact center queues for an organization. ' enum: - SPECIFIC - ALL - PROVISIONED_VALUE - NONE example: ALL accessAllTeams: type: string description: 'Allow users of this profile access to specific or all the contact center teams for an organization. It can take one of these values: ALL — A contact center user with this profile can access all the contact center teams for an organization. SPECIFIC — A contact center user with this profile can access only specific contact center teams for an organization. ' enum: - SPECIFIC - ALL - PROVISIONED_VALUE - NONE example: ALL active: type: boolean description: Specify whether the User profile is active or not. example: true editableFolderIds: type: array description: "Indicates the id(s) of the reporting folders a user of this profile has read and write access to. \n" example: - 1 - 2 items: type: integer format: int32 description: "Indicates the id(s) of the reporting folders a user of this profile has read and write access to. \n" example: 1 uniqueItems: true viewableFolderIds: type: array description: "Indicates the id(s) of the reporting folders a user of this profile has read access to. \n" example: - 1 - 2 items: type: integer format: int32 description: "Indicates the id(s) of the reporting folders a user of this profile has read access to. \n" example: 1 uniqueItems: true nonViewableFolderIds: type: array description: "Indicates the id(s) of the restricted reporting folders for a user of this profile. \n" example: - 1 - 2 items: type: integer format: int32 description: "Indicates the id(s) of the restricted reporting folders for a user of this profile. \n" example: 1 uniqueItems: true systemDefault: type: boolean description: Indicates whether the created resource is system created or not example: false createdTime: type: integer format: int64 description: This is the created time of the entity. lastUpdatedTime: type: integer format: int64 description: This is the updated time of the entity. entryPoints: type: array description: "Specify the id(s) of the entry point(s) a user of this profile will have access to. \n\nIt should be chosen when entry points access is SPECIFIC. Please see '''Entry Point documentation''', and use Get EntryPoints API to fetch the values of entry points.\n\n" example: - f53c8b54-46ca-43f6-ba05-08426a46e23d - a53c8b54-46ca-43f6-ba05-08426a46e23f items: type: string description: "Specify the id(s) of the entry point(s) a user of this profile will have access to. \n\nIt should be chosen when entry points access is SPECIFIC. Please see '''Entry Point documentation''', and use Get EntryPoints API to fetch the values of entry points.\n\n" example: f53c8b54-46ca-43f6-ba05-08426a46e23d uniqueItems: true sites: type: array description: "Specify the id(s) of the site(s) a user of this profile will have access to. \nIt should be chosen when sites access is SPECIFIC. Please see Sites documentation, and use Get Site API to fetch the values of site IDs.\n\n" example: - f53c8b54-46ca-43f6-ba05-08426a46e23d - a53c8b54-46ca-43f6-ba05-08426a46e23f items: type: string description: "Specify the id(s) of the site(s) a user of this profile will have access to. \nIt should be chosen when sites access is SPECIFIC. Please see Sites documentation, and use Get Site API to fetch the values of site IDs.\n\n" example: f53c8b54-46ca-43f6-ba05-08426a46e23d uniqueItems: true queues: type: array description: "Specify the id(s) of the queue(s) a user of this profile will have access to. \nIt should be chosen when queues access is SPECIFIC. Please see Queues documentation, and use Get Queues API to fetch the values of queue IDs.\n\n" example: - f53c8b54-46ca-43f6-ba05-08426a46e23d - a53c8b54-46ca-43f6-ba05-08426a46e23f items: type: string description: "Specify the id(s) of the queue(s) a user of this profile will have access to. \nIt should be chosen when queues access is SPECIFIC. Please see Queues documentation, and use Get Queues API to fetch the values of queue IDs.\n\n" example: f53c8b54-46ca-43f6-ba05-08426a46e23d uniqueItems: true teams: type: array description: 'Specify the id(s) of the team(s) a user of this profile will have access to. It should be chosen when teams access is SPECIFIC. Please see Teams documentation, and use Get Teams API to fetch the values of team IDs. ' example: - f53c8b54-46ca-43f6-ba05-08426a46e23d - a53c8b54-46ca-43f6-ba05-08426a46e23f items: type: string description: 'Specify the id(s) of the team(s) a user of this profile will have access to. It should be chosen when teams access is SPECIFIC. Please see Teams documentation, and use Get Teams API to fetch the values of team IDs. ' example: f53c8b54-46ca-43f6-ba05-08426a46e23d uniqueItems: true required: - accessAllEntryPoints - accessAllModules - accessAllQueues - accessAllSites - accessAllTeams - active - name - profileType UserProfileAppFeatureDTO_UserResponseWithUserProfile: type: object description: The user profile application feature settings with user profile details. properties: organizationId: type: string format: uuid description: ID of the contact center organization. This field is required for all bulk save operations. example: f53c8b54-46ca-43f6-ba05-08426a46e23d maxLength: 36 minLength: 32 pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$ id: type: string description: ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource. example: 93912f11-6017-404b-bf14-5331890b1797 version: type: integer format: int32 description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise. example: 1 appFeatureId: type: string description: "The feature code of a Webex Contact Center module. \n\nPlease add all the following features with their respective modules and set it's featureAccessType to 'ON' or 'OFF', to specify if it is in use. Here is the complete list of Feature names and Feature Ids:\n\n\nFor module 'm_additional_supervisory_features' we have the following features:\n\nChange Agent States : f_change_agent_states\n\nSign out Agents : f_sign_out_agents\n\nSend Messages : f_send_messages\n\nRe-skill Agents : f_reskill_agents\n\nManage agent based queues : f_manage_agent_queue_assignments\n\nFor module 'm_real_time_reports' we have the following features:\n\nReal Time Threshold Alerts : f_realtime_threshold_alerts\n\nAgent State Change : f_agent_state_change\n\nSummary View : f_summary_view\n\nWeb Callback Report : f_web_callback_report\n\n\nFor module 'm_multimedia' we have the following features:\n\nMM Agent Desktop : f_mm_agent_desktop\n\nBasic Digital : f_mm_basic_digital\n\nMM Provisioning : f_mm_provisioning\n\nSocial Channel : f_mm_social_channel\n\n\nFor module 'm_reporting_analytics' we have the following features:\n\nAnalyzer Data Exchange : f_analyzer_data_exchange\n\nBusiness Rules : f_business_rules\n\n\nFor module 'm_manage_agent_states' we have the following features:\n\nChange Agent State : f_change_agent_state\n\nSign Out Agent : f_sign_out_agent\n\n\nFor module 'm_recording_management' we have the following features:\n\nCustom Attributes : f_custom_attributes\n\nManage Recordings : f_manage_recordings\n\nTags : f_tags\n\nSecurity Keys : f_security_keys\n\n\nFor module 'm_routing_strategy' we have the following features:\n\nManage Call Flow Scripts : f_manage_call_flow_scripts\n\nManage Media Files : f_manage_media_files\n\n\nFor module 'm_provisioning' we have the following features:\n\nManage EntryPoints and Queues : f_manage_teams\n\nManage Users : f_manage_users\n\nDN Mappings : f_dn_mappings\n\nManage Sites : f_manage_sites\n\nManage Teams : f_manage_teams\n\nManage User Profiles : f_manage_user_profiles\n\nRevoke API Key : f_revoke_api_key\n\nManage Dial Plans : f_manage_dial_plans\n\nManage Tenants : f_manage_tenants\n\nManage Entry Points and Queues : f_manage_entrypt_queue\n\nPortal Branding : f_portal_branding\n\nAudit Trail : f_audit_trail\n\nManage Business Hours : f_manage_business_hours\n\n\nFor module 'm_call_monitoring' we have the following features:\n\nMid Call Monitoring : f_mid_call_monitor\n\nBarge In : f_barge_in\n\nRestricted Monitor : f_restricted_monitor_only\n\nWhisper Coach : f_whisper_coach\n\nView Blind Monitor Request : f_view_blind_monitor_requests\n\n" example: f_manage_sites minLength: 1 appFeatureName: type: string description: The feature name of the Webex Contact Center module. example: Manage Sites featureAccessType: type: string description: 'Indicates whether a user of this profile has access to a module feature. It can be one of these values: OFF — A contact center user with this profile cannot access this module feature. ON — A contact center user with this profile can access this module feature. ' enum: - 'OFF' - 'ON' example: 'ON' createdTime: type: integer format: int64 description: This is the created time of the entity. lastUpdatedTime: type: integer format: int64 description: This is the updated time of the entity. required: - appFeatureId - featureAccessType UserDTO: type: object description: The request object for creating or updating a user in the contact center. properties: organizationId: type: string format: uuid description: ID of the contact center organization. This field is required for all bulk save operations. example: f53c8b54-46ca-43f6-ba05-08426a46e23d maxLength: 36 minLength: 32 pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$ id: type: string description: ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource. example: 93912f11-6017-404b-bf14-5331890b1797 version: type: integer format: int32 description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise. example: 1 firstName: type: string description: The first name of the user. Can be changed using Users Management in Cisco Webex Control Hub. example: John minLength: 1 lastName: type: string description: The last name of the user. Can be changed using Users Management in Cisco Webex Control Hub. example: Wick minLength: 1 email: type: string description: The email address of the user. Can be changed using Users Management in Cisco Webex Control Hub. example: johnwick@company.com minLength: 1 workPhone: type: string description: The work phone number of the user. example: '1234567890' maxLength: 20 minLength: 0 mobile: type: string description: The mobile phone number of the user. example: '1234567890' maxLength: 20 minLength: 0 ciUserId: type: string description: Cisco Common Identity user Id. Existence of a CI user is a prerequisite to create a new WxCC user. It cannot be modified. example: 1dq21e23-1234-5578-9a83-2afdae0d4ba1 minLength: 1 broadCloudUserId: type: string description: Broadcloud user Id. This field cannot be modified. example: 1dq21e23-1234-5578-9a83-2afdae0d4ba1 userProfileId: type: string description: Identifier for an user profile which a Contact Center administrator has configured. Changing the profile type requires a token with `FLS:Read_Scope` scope. As of today, changing the profile type for a user is supported only from Cisco Webex Control Hub. example: 1dq21e23-1234-5578-9a83-2afdae0d4ba1 minLength: 1 contactCenterEnabled: type: boolean description: The setting is for accessing the Agent Desktop to handle customer requests. example: true timezone: type: string description: (Optional) The time zone that you provision for your enterprise. example: America/New_York xspVersion: type: string description: (Optional) Used to subscribe for recording events. This field cannot be modified. example: xsp-24.0 maxLength: 80 minLength: 0 subscriptionId: type: string description: (Optional) Used to subscribe for recording events. This field cannot be modified. example: 04d0bdf6-6d6a-4aae-8a8a-71c9152e6478 maxLength: 80 minLength: 0 siteId: type: string description: (Optional) Identifier for a site which is a physical contact center location under the control of your enterprise. This field is applicable only when contactCenterEnabled is true. example: 8e6bb6da-2a78-4768-bef9-7e229f92af22 teamIds: type: array description: "Specify the teams id which got assigned to this user. \nNote: You can’t assign this profile to a capacity-based team. This field is applicable only when contactCenterEnabled is true." example: - f53c8b54-46ca-43f6-ba05-08426a46e23d - a53c8b54-46ca-43f6-ba05-08426a46e23f items: type: string description: "Specify the teams id which got assigned to this user. \nNote: You can’t assign this profile to a capacity-based team. This field is applicable only when contactCenterEnabled is true." example: f53c8b54-46ca-43f6-ba05-08426a46e23d uniqueItems: true skillProfileId: type: string description: (Optional) If your enterprise uses the optional Skills-Based Routing feature, This profile overrides any skill profile at the team level that is associated with the agent.This field is applicable only when contactCenterEnabled is true. example: f53c8b54-46ca-43f6-ba05-08426a46e23d agentProfileId: type: string description: Identifier for a Desktop Profile which is a group of permissions and Agent Desktop behaviors that you assign to specific users. This field is applicable only when contactCenterEnabled is true. example: 8e6bb6da-2a78-4768-bef9-7e229f92af22 multimediaProfileId: type: string description: (Optional) If your organization administrator enables Multimedia for your enterprise, you can select a multimedia profile for this team. This field is applicable only when contactCenterEnabled is true. example: f53c8b54-46ca-43f6-ba05-08426a46e23d deafultDialledNumber: type: string description: (Optional) The dial number of the agent. This field is applicable only when contactCenterEnabled is true. example: '1234567890' externalIdentifier: type: string description: (Optional) Agent identification details, such as the employee number. example: '121212' active: type: boolean description: Indicates whether the user is active or not active. Can be changed using Users Management in Cisco Webex Control Hub. example: true imiUserCreated: type: boolean description: (Optional) Indicates whether this user has a corresponding user created in IMI digital channel. This field cannot be modified. example: false preferredSupervisorTeamId: type: string description: (Optional) Indicates the id of a preferred supervisor. example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1 userLevelBurnoutInclusion: type: string description: 'User level burnout inclusion type. Used only when Agent inclusion is set to ''Specific Agents'' at the org level Agent Wellbeing>Burnout config. During entity creation(single or bulk), if this parameter is not provided or null, default will be set to ''EXCLUDED'' During entity update(single or bulk), if this parameter is not provided or null, the previous value will be retained.' enum: - INCLUDED - EXCLUDED example: INCLUDED userLevelAutoCSATInclusion: type: string description: 'User level AutoCSAT inclusion type. Used only when Agent inclusion is set to ''Specific Agents'' at the org level Cisco AI Assistant>Auto CSAT config. During entity creation(single or bulk), if this parameter is not provided or null, default will be set to ''EXCLUDED'' During entity update(single or bulk), if this parameter is not provided or null, the previous value will be retained.' enum: - INCLUDED - EXCLUDED example: INCLUDED userLevelWellnessBreakReminders: type: string description: 'User level Wellness break reminder type. If top level Agent burnout config has wellness break reminders enabled, this property determines if an Agent is enabled/disabled for receiving break reminders. ' enum: - DISABLED - ENABLED example: DISABLED userLevelSummariesInclusion: type: string description: 'User level Generated Summaries inclusion type. Used only when Generated Summaries is set to ''Specific Agents'' at the org level Cisco AI Assistant>Generated Summaries. During entity creation(single or bulk), if this parameter is not provided or null, default will be set to ''EXCLUDED'' During entity update(single or bulk), if this parameter is not provided or null, the previous value will be retained.' enum: - INCLUDED - EXCLUDED example: INCLUDED dynamicSkills: type: array description: The list of dynamic skills assigned to the user example: - organizationId: 21ec9a4a-2b8a-418c-afa5-4ff40e6a17f7 skillId: 2683334c-abec-4c0b-a6b1-211bd81d1b4b textValue: abc - organizationId: 21ec9a4a-2b8a-418c-afa5-4ff40e6a17f7 skillId: 2683334c-abec-4c0b-a6b1-211bd81d1b4b proficiencyValue: 7 items: $ref: '#/components/schemas/AssignedDynamicSkillsDTO' createdTime: type: integer format: int64 description: This is the created time of the entity. lastUpdatedTime: type: integer format: int64 description: This is the updated time of the entity. required: - active - ciUserId - contactCenterEnabled - email - firstName - lastName - userProfileId QueuesCountDTO: type: object description: 'The count of each type of Contact Service Queues that the user is assigned to. ' example: teamBased: 0 skillBased: 0 agentBased: 0 properties: teamBased: type: integer format: int32 description: The count of team-based queues assigned to the user. skillBased: type: integer format: int32 description: The count of skill-based queues assigned to the user. agentBased: type: integer format: int32 description: The count of agent-based queues assigned to the user. ResourceCollectionDTO: type: object description: A collection of resources with their types and access levels. example: id: 80f49a6e-11d7-4651-b730-99ed2f726f61 name: Department1 description: Department1 description. resources: - name: team accessLevel: SPECIFIC ids: - 00734874-4732-43bb-bfff-d1e75d309eb1 - 00734874-4732-43bb-bfff-d1e75d309eb2 - name: desktop-profile accessLevel: ALL - name: desktop-layout accessLevel: NONE resourceCount: 2 properties: organizationId: type: string format: uuid description: ID of the contact center organization. This field is required for all bulk save operations. example: f53c8b54-46ca-43f6-ba05-08426a46e23d maxLength: 36 minLength: 32 pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$ id: type: string description: ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource. example: 93912f11-6017-404b-bf14-5331890b1797 version: type: integer format: int32 description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise. example: 1 name: type: string description: The name of the resource collection. example: Department1 maxLength: 80 minLength: 1 pattern: ^[a-zA-Z\d-_\s]+$ description: type: string description: An optional description of the resource collection. example: Department1 description. maxLength: 255 minLength: 0 resources: type: array description: The name of the resource and Type of resource list. items: $ref: '#/components/schemas/ResourceTypesDTO' uniqueItems: true resourceCount: type: integer format: int64 description: The total count of resources in this collection example: 2 createdTime: type: integer format: int64 description: This is the created time of the entity. lastUpdatedTime: type: integer format: int64 description: This is the updated time of the entity. required: - name ResourceTypesDTO_UserResponseWithUserProfileGranularAccess: type: object description: A resource type with its access level and associated IDs. properties: name: type: string description: 'The name of the resource.multimedia-profile - Has access to multimedia profile[multimedia-profile] resource name. queue - Has access to queue[queue] resource name. override - Has access to override[override] resource name. holiday-list - Has access to holiday list[holiday-list] resource name. audio-prompt - Has access to audio prompt[audio-prompt] resource name. flow - Has access to flow[flow] resource name. skill-profile - Has access to skill profile[skill-profile] resource name. team - Has access to team[team] resource name. skill-definition - Has access to skill definition[skill-definition] resource name. site - Has access to site[site] resource name. outdial-ani - Has access to outdial ani[outdial-ani] resource name. channel - Has access to channel[channel] resource name. sub-flow - Has access to sub flow[sub-flow] resource name. desktop-layout - Has access to desktop layout[desktop-layout] resource name. working-hour - Has access to working hour[working-hour] resource name. function - Has access to function[function] resource name. desktop-profile - Has access to desktop profile[desktop-profile] resource name. idle-wrapup-code - Has access to idle wrap-up code[idle-wrapup-code] resource name. cad-variable - Has access to cad variable[cad-variable] resource name. address-book - Has access to address book[address-book] resource name. ' example: site minLength: 1 accessLevel: type: string description: This can be used to allow users to access specific, none or all resources. enum: - SPECIFIC - ALL - PROVISIONED_VALUE - NONE example: ALL ids: type: array description: The id of the resource can be used to allow users to access specific, of resources. example: - 00734874-4732-43bb-bfff-d1e75d309eb1 - 00734874-4732-43bb-bfff-d1e75d309eb2 items: type: string uniqueItems: true required: - accessLevel - name AssignedDynamicSkillsDTO_UserResponseWithUserProfileGranularAccess: type: object description: The list of dynamic skills associated with the user properties: organizationId: type: string format: uuid description: ID of the contact center organization. This field is required for all bulk save operations. example: f53c8b54-46ca-43f6-ba05-08426a46e23d maxLength: 36 minLength: 32 pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$ id: type: string description: ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource. example: 93912f11-6017-404b-bf14-5331890b1797 version: type: integer format: int32 description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise. example: 1 skillId: type: string description: The ID of the skill. example: skill456 minLength: 1 textValue: type: string description: A short textual description that represents a skill the agent has. example: Credit card SME maxLength: 100 minLength: 0 booleanValue: type: boolean description: Indicates whether the agent has this skill (True) or does not have the skill (False). example: true proficiencyValue: type: integer format: int32 description: A number between 0 and 10 to indicate how proficient the agent is in this skill. example: 5 maximum: 10 minimum: 0 enumSkillValues: type: string description: Indicates a value that represents a skill the agent has. example: FRENCH skillName: type: string createdTime: type: integer format: int64 description: This is the created time of the entity. lastUpdatedTime: type: integer format: int64 description: This is the updated time of the entity. required: - skillId MetaDataReferencesPagingInfo: title: MetaDataReferencesPagingInfo type: object properties: orgid: maxLength: 36 minLength: 32 pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$ type: string description: Org ID format: uuid example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1 page: type: integer description: Current page number format: int32 example: 1 pageSize: type: integer description: Page size for current data set format: int32 example: 100 totalPages: type: integer description: Number of pages format: int32 example: 1 totalRecords: type: integer description: Total number of items format: int32 example: 1000 links: type: object description: Map of pagination links with self, next, prev, last and first example: next: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/cad-variable?page=2&pageSize=10 last: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/cad-variable?page=3&pageSize=10 prev: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/cad-variable?page=0&pageSize=10 self: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/cad-variable?page=1&pageSize=10 first: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/cad-variable?page=0&pageSize=10 referencedEntities: type: array description: List of referenced entities example: - agent-profile - entrypoint items: type: string currentEntity: type: string description: Name of current entity example: entity_name description: Metadata of response for references with paging information UserResponseDTO_UserResponseWithUserProfile: type: object description: The response object representing a user with user profile details. properties: organizationId: type: string format: uuid description: ID of the contact center organization. This field is required for all bulk save operations. example: f53c8b54-46ca-43f6-ba05-08426a46e23d maxLength: 36 minLength: 32 pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$ id: type: string description: ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource. example: 93912f11-6017-404b-bf14-5331890b1797 version: type: integer format: int32 description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise. example: 1 firstName: type: string description: The first name of the user. example: John lastName: type: string description: The last name of the user. example: Wick email: type: string description: The email address of the user. example: johnwick@company.com workPhone: type: string description: The work phone number of the user. example: '1234567890' mobile: type: string description: The mobile phone number of the user. example: '1234567890' ciUserId: type: string description: Cisco Common Identity user Id example: 1dq21e23-1234-5578-9a83-2afdae0d4ba1 broadCloudUserId: type: string description: Broadcloud user Id example: 1dq21e23-1234-5578-9a83-2afdae0d4ba1 timezone: type: string description: (Optional) The time zone that you provision for your enterprise. example: America/New_York xspVersion: type: string description: (Optional) Used to subscribe for recording events. example: xsp-24.0 subscriptionId: type: string description: (Optional) Used to subscribe for recording events. example: 04d0bdf6-6d6a-4aae-8a8a-71c9152e6478 userProfileId: type: string description: Identifier for an user profile which a Contact Center administrator has configured. example: 1dq21e23-1234-5578-9a83-2afdae0d4ba1 userProfileType: type: string description: Type of the user profile associated to this user. This is an optional response parameter based on the query parameter includeUserProfileType. example: PREMIUM_AGENT contactCenterEnabled: type: boolean description: The setting is for accessing Desktop to handle customer requests. example: true siteId: type: string description: Details of site which a Contact Center administrator has configured for the user. example: 1dq21e23-1234-5578-9a83-2afdae0d4ba1 siteName: type: string description: site name that user is associated with example: bengaluru teamIds: type: array description: "Specify the teams id which got assigned to this user. \nNote: You can’t assign this profile to a capacity-based team." example: - f53c8b54-46ca-43f6-ba05-08426a46e23d - a53c8b54-46ca-43f6-ba05-08426a46e23f items: type: string description: "Specify the teams id which got assigned to this user. \nNote: You can’t assign this profile to a capacity-based team." example: f53c8b54-46ca-43f6-ba05-08426a46e23d uniqueItems: true skillProfileId: type: string description: '(Optional) If your enterprise uses the optional Skills-Based Routing feature, This profile overrides any skill profile at the team level that is associated with the agent ' example: f53c8b54-46ca-43f6-ba05-08426a46e23d agentProfileId: type: string description: Identifier for a Desktop Profile which is a group of permissions and Agent Desktop behaviors that you assign to specific users. example: 8e6bb6da-2a78-4768-bef9-7e229f92af22 multimediaProfileId: type: string description: (Optional) If your organization administrator enables Multimedia for your enterprise, you can select a multimedia profile for this team. example: f53c8b54-46ca-43f6-ba05-08426a46e23d deafultDialledNumber: type: string description: (Optional) The dial number of the agent. example: '1234567890' externalIdentifier: type: string description: (Optional) Agent identification details, such as the employee number. example: '121212' active: type: boolean description: Specify whether the user is active or not active. example: true dbId: type: string description: Legacy identifier for migrated users. example: 1dq45f23-1234-6r18-9a83-2atuiy0d4bh1 userProfileData: $ref: '#/components/schemas/UserProfileDTO_UserResponseWithUserProfile' description: Details of UserProfile which a Contact Center administrator has configured for the user.This is an optional object, returned only when the endpoint 'Get User along with profile by ID' is invoked. imiUserCreated: type: boolean description: Specify whether or not the corresponding user is created in IMI. example: true preferredSupervisorTeamId: type: string description: The teamId to look for to load the desktop layout when a supervisor logs in to desktop. example: e27d2b54-46ca-43g6-ba65-08426e46e23d systemDefault: type: boolean description: Indicates whether the created resource is system created or not example: false userLevelBurnoutInclusion: type: string description: 'User level burnout inclusion type. Used only when Agent inclusion is set to ''Specific Agents'' at the org level Agent Wellbeing>Burnout config. ' enum: - INCLUDED - EXCLUDED example: INCLUDED userLevelAutoCSATInclusion: type: string description: 'User level AutoCSAT inclusion type. Used only when Agent inclusion is set to ''Specific Agents'' at the org level Cisco AI Assistant>Auto CSAT config. ' enum: - INCLUDED - EXCLUDED example: INCLUDED userLevelWellnessBreakReminders: type: string description: 'User level Wellness break reminder type. If top level Agent burnout config has wellness break reminders enabled, this property determines if an Agent is enabled/disabled for receiving break reminders. ' enum: - DISABLED - ENABLED example: DISABLED userLevelSummariesInclusion: type: string description: 'User level Generated Summaries inclusion type. Used only when Generated Summaries is set to ''Specific Agents'' at the org level Cisco AI Assistant>Generated Summaries. ' enum: - INCLUDED - EXCLUDED example: INCLUDED queuesCount: $ref: '#/components/schemas/QueuesCountDTO_UserResponseWithUserProfile' description: 'The count of each type of Contact Service Queues that the user is assigned to. ' example: "{\n \"teamBased\": 0\n \"skillBased\": 0\n \"agentBased\": 0\n}" skillProfileUpdatedBy: type: string description: The ID of the user who last modified the skill profile example: 1dq21e23-1234-5578-9a83-2afdae0d4ba1 dynamicSkills: type: array description: The list of dynamic skills associated with the user items: $ref: '#/components/schemas/AssignedDynamicSkillsDTO_UserResponseWithUserProfile' dynamicSkillsLimitReached: type: boolean description: Indicates if the user has reached the dynamic skills assignment limit. Present only if includeDynamicSkillsLimitReached=true is passed in the request. example: true dynamicSkillsUpdatedBy: type: string description: The name of the user who last modified dynamic skills dynamicSkillsUpdatedTime: type: integer format: int64 description: The date when dynamic skills were last modified example: 1679393400000 dynamicSkillAssigned: type: boolean description: Indicates if the user has the specified dynamic skill assigned. Present only if checkIfUserHasDynamicSkill=true and dynamicSkillId are provided in the request. example: true createdTime: type: integer format: int64 description: This is the created time of the entity. lastUpdatedTime: type: integer format: int64 description: This is the updated time of the entity. skillProfileUpdatedTime: type: integer format: int64 description: The date when the skill profile was last modified example: 1679393400000 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