openapi: 3.0.0
info:
title: Webex Admin Address Book User Profiles 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: User Profiles
paths:
/organization/{orgid}/user-profile/{id}/incoming-references:
get:
tags:
- User Profiles
summary: List references for a specific User Profile
description: Retrieve a list of all entities that have reference to an existing user profile by ID in a given organization.
operationId: getIncomingReferencesUserProfile
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:
'*/*':
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}/v3/user-profile:
get:
tags:
- User Profiles
summary: List user profiles
description: "Retrieve a list of user profiles in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API."
operationId: getAllConfigWithMetaDataUserProfileGranularAccess
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, userProfileAppModules, entryPoints, sites, queues, teams, editableFolderIds, viewableFolderIds, nonViewableFolderIds, 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=="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. except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)
required: false
schema:
type: string
format: string
example: id
- name: search
in: query
description: 'Filter data based on the search keyword.Supported search columns(name, profileType, description)
The examples below show some search queries
- "Cisco"
- field=="name";value=="Cisco"
- fields=in=("name","description");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
responses:
'200':
description: OK
content:
'*/*':
schema:
type: string
example: "\"{\n \"meta\": {\n \"orgid\": \"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\",\n \"page\": 1,\n \"pageSize\": 100,\n \"totalPages\": 1,\n \"totalRecords\": 1000,\n \"links\": {\n \"next\": \"/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/user-profile?page=2&pageSize=10\",\n \"last\": \"/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/user-profile?page=3&pageSize=10\",\n \"prev\": \"/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/user-profile?page=0&pageSize=10\",\n \"self\": \"/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/user-profile?page=1&pageSize=10\",\n \"first\": \"/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/user-profile?page=0&pageSize=10\"\n }\n },\n \"data\": [\n {\n \"organizationId\": \"f53c8b54-46ca-43f6-ba05-08426a46e23d\",\n \"id\": \"93912f11-6017-404b-bf14-5331890b1797\",\n \"version\": 1,\n \"name\": \"Contact Center Admin Profile\",\n \"description\": \"This profile should be applied only to contact center admins.\",\n \"profileType\": \"PREMIUM_AGENT\",\n \"active\": true,\n \"permissionAccessLevel\": \"ALL\",\n \"resourceAccessLevel\": \"ALL\",\n \"permissions\": [\n {\n \"id\": \"00734874-4732-43bb-bfff-d1e75d309eb1\",\n \"name\": \"sites\",\n \"access\": \"NONE\"\n }\n ],\n \"editableFolderIds\": [\n 1,\n 2\n ],\n \"viewableFolderIds\": [\n 1,\n 2\n ],\n \"nonViewableFolderIds\": [\n 1,\n 2\n ],\n \"systemDefault\": false,\n \"defaultResourceCollectionId\": \"80f49a6e-11d7-4651-b730-99ed2f726f61\",\n \"resourceCollections\": [\n {\n \"id\": \"80f49a6e-11d7-4651-b730-99ed2f726f61\",\n \"name\": \"Department1\",\n \"description\": \"Department1 description.\",\n \"resources\": [\n {\n \"name\": \"team\",\n \"accessLevel\": \"SPECIFIC\",\n \"ids\": [\n \"00734874-4732-43bb-bfff-d1e75d309eb1\",\n \"00734874-4732-43bb-bfff-d1e75d309eb2\"\n ]\n },\n {\n \"name\": \"desktop-profile\",\n \"accessLevel\": \"ALL\"\n },\n {\n \"name\": \"desktop-layout\",\n \"accessLevel\": \"NONE\"\n }\n ],\n \"resourceCount\": 2\n }\n ],\n \"createdTime\": 0,\n \"lastUpdatedTime\": 0\n }\n ]\n }\n\""
properties:
meta:
$ref: '#/components/schemas/MetaDataWithPagingInfo'
data:
type: array
items:
$ref: '#/components/schemas/UserProfileGranularAccessDTO'
'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: []
post:
tags:
- User Profiles
summary: Create a new User Profile
description: Create a new user profile in a given organization.
operationId: createConfigUserProfileGranularAccess
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:
content:
application/json:
schema:
$ref: '#/components/schemas/UserProfileGranularAccessDTO'
required: true
responses:
'201':
description: Created
content:
'*/*':
schema:
$ref: '#/components/schemas/UserProfileGranularAccessDTO'
'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}/v3/user-profile/bulk:
post:
tags:
- User Profiles
summary: Bulk save User Profiles
description: Create, Update or delete user profiles in bulk in a given organization.
operationId: saveAllConfigUserProfileGranularAccess
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:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkRequestDTOUserProfileGranularAccessDTO'
required: true
responses:
'207':
description: Multi-Status
content:
'*/*':
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: []
'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}/v3/user-profile/{id}:
get:
tags:
- User Profiles
summary: Get specific User Profile by ID
description: Retrieve an existing user profile by ID in a given organization.
operationId: getConfigUserProfileGranularAccess
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 Profile.
required: true
schema:
type: string
example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2
- name: includeNames
in: query
description: Flag to include resource names in the response.
required: false
schema:
type: boolean
example: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/UserProfileGranularAccessDTO'
'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:
- User Profiles
summary: Update specific User Profile by ID
description: Update an existing user profile by ID in a given organization.
operationId: updateConfigUserProfileGranularAccess
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 Profile.
required: true
schema:
type: string
example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserProfileGranularAccessDTO'
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/UserProfileGranularAccessDTO'
'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: []
delete:
tags:
- User Profiles
summary: Delete specific User Profile by ID
description: Delete an existing user profile by ID in a given organization.
operationId: deleteConfigUserProfileGranularAccess
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 Profile.
required: true
schema:
type: string
example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2
responses:
'204':
description: No Content
'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: []
/organization/{orgid}/v3/user-profile/{id}/acl:
get:
tags:
- User Profiles
summary: Get specific User Profile ACL by ID
description: Retrieve an existing User Profile ACL by ID in a given organization.
operationId: getACLByUserProfileUserProfileGranularAccess
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 Profile.
required: true
schema:
type: string
example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2
- name: names
in: query
description: " Default all resources are returned in the ACL.\n If you want to filter the ACL by specific resources,\n provide a comma-separated list of resource names to filter the ACL. Ex: /url?names=site,team\n"
required: false
style: form
explode: false
schema:
type: array
items:
type: string
example:
- site
- team
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/AccessControlListDTO'
'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
BulkRequestItemDTOUserProfileGranularAccessDTO:
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/UserProfileGranularAccessDTO'
requestAction:
type: string
description: Identifier for action type. Possible values are `SAVE` and `DELETE`.
example: SAVE
AccessControlListDTO:
type: object
description: Access Control List is higher order DTO of user profile and resource collection.
example:
organizationId: f53c8b54-46ca-43f6-ba05-08426a46e23d
id: 93912f11-6017-404b-bf14-5331890b1797
version: 1
name: Administrator
profileType: ADMINISTRATOR
description: User Profile Description
active: true
permissionAccessLevel: ALL
resourceAccessLevel: ALL
editableFolderIds:
- 1
- 2
- 3
viewableFolderIds:
- 4
- 5
- 6
nonViewableFolderIds:
- 7
- 8
- 9
defaultResourceCollectionId: 123e4567-e89b-12d3-a456-426614174000
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
permissions:
- id: 00734874-4732-43bb-bfff-d1e75d309eb1
name: sites
access: NONE
resources:
- name: site
accessLevel: ALL
ids:
- 00734874-4732-43bb-bfff-d1e75d309eb1
- 00734874-4732-43bb-bfff-d1e75d309eb2
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: name of the user profile as ACL.
example: Administrator
profileType:
type: string
description: User Profile Type.
enum:
- ADMINISTRATOR
- ADMINISTRATOR_ONLY
- SUPERVISOR
- PREMIUM_AGENT
- STANDARD_AGENT
- ANALYZER_ADMINISTRATOR
- ANALYZER_SUPERVISOR
- ANALYZER_USER
example: ADMINISTRATOR
description:
type: string
description: User Profile Description.
example: User Profile Description
active:
type: boolean
description: Indicates whether the user profile is active.
example: true
permissionAccessLevel:
type: string
description: Permissions Access Level for user profile level.
enum:
- SPECIFIC
- ALL
- PROVISIONED_VALUE
- NONE
example: ALL
resourceAccessLevel:
type: string
description: Resource Access Level for resource collection level.
enum:
- SPECIFIC
- ALL
- PROVISIONED_VALUE
- NONE
example: ALL
editableFolderIds:
type: array
description: Set of editable folder IDs that are part of user profile.
example:
- 1
- 2
- 3
items:
type: integer
format: int32
uniqueItems: true
viewableFolderIds:
type: array
description: Set of viewable folder IDs that the part of user profile.
example:
- 4
- 5
- 6
items:
type: integer
format: int32
uniqueItems: true
nonViewableFolderIds:
type: array
description: Set of non-viewable folder IDs that are part of user profile.
example:
- 7
- 8
- 9
items:
type: integer
format: int32
uniqueItems: true
defaultResourceCollectionId:
type: string
description: Default Resource Collection ID.
example: 123e4567-e89b-12d3-a456-426614174000
resourceCollections:
type: array
description: Set of resource collections associated with the User Profile.
items:
$ref: '#/components/schemas/ResourceCollectionDTO'
uniqueItems: true
permissions:
type: array
description: Set of permissions associated with the User Profile.
items:
$ref: '#/components/schemas/UserProfilePermissionsDTO'
uniqueItems: true
resources:
type: array
description: Set of resources associated with the Resource Collection.
items:
$ref: '#/components/schemas/ResourceTypesDTO'
uniqueItems: true
createdTime:
type: integer
format: int64
description: This is the created time of the entity.
example: 123456789
lastUpdatedTime:
type: integer
format: int64
description: This is the updated time of the entity.
example: 123456789
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'
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'
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
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
BulkRequestDTOUserProfileGranularAccessDTO:
type: object
properties:
items:
type: array
description: List of items in the bulk request.
items:
$ref: '#/components/schemas/BulkRequestItemDTOUserProfileGranularAccessDTO'
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.
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
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
BulkResponseDTO:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/BulkResponseItemDTO'
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
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
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
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'
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