Roles specify the
APIs that an administrator can use, and which menus and tools an administrator
can see and use.
Use the Role API to
list the roles currently defined in the database, or edit, delete, or create
new custom roles.
Roles
Cisco
Packaged CCE database has four built-in roles for administrators that set the
access to specific features (APIs and tools). The built-in roles are
hierarchical in that each role identified in the table below contains the
access rights of the roles above it. You cannot alter the feature access for
the built-in roles, but you can create additional roles to define customized
sets of feature access.
This role
|
Allows full access to
|
AgentAdmin
|
Agent
APIs and tools only.
|
ScriptAdmin
|
Agent,
Call, and Scripting tools - including Bulk Jobs.
|
ConfigAdmin
|
All APIs
and tools except administrator, departments, and roles.
|
SystemAdmin
|
All
APIs and tools. Only this role provides access to the Administrator,
Department, and Role features.
|
For more
information on these roles, see the
Packaged CCE Administration
Guide.
URL
https://<server>:<serverport>/unifiedconfig/config/role
Operations
-
create: Creates
one role, given the specified name, description, and featureList.
-
delete: Deletes
one role permanently from the database.
-
get: Returns one
role using the URL
https://<server>/unifiedconfig/config/role/<id>.
-
Auxiliary get method returns the accessList parameter containing a collection
of all features that can be used to define a role. Use the URL
https://<server>/unifiedconfig/config/role/available_features.
-
list: Retrieves a
list of roles.
-
update: Gets the
role item and updates the new configuration entered in the <accessList>
fields.
Parameters
-
refURL: The
refURL of the role. See
Shared parameters.
-
name: The role
name, such as ConfigAdmin. See
Shared parameters.
-
changeStamp:
See
Shared parameters.
-
description:
See
Shared parameters.
-
accessList:
A collection of features that indicates which APIs and tools the administrators
assigned to this role can access.
-
feature:
Element of the access list that represents access to a feature (API / tool).
Includes the following parameters:
-
name: Feature name. Maps to a valid API / tool.
-
category: Feature category, such as Agent, Call, System, and
Access. This parameter is used only for get and list operations.
-
administrators: A collection of administrator references (Administrator API), including the user name,
domain name, and refURL of the administrator. See
References.
-
systemDefined: Read-only parameter. Indicates if this role is a
system-defined role. Values are true/false.
Search and
sort values
The following
table shows the parameters that are searched and the parameters that are
sortable.
Search parameters
|
Sort parameters
|
|
- name (default)
- description
|
See
Search and
Sort.
Advanced search
parameters
You can perform
a system defined role search on the Role API:
-
systemDefined:(both/only/none): Allows searching of roles with the
specified value of the systemDefined parameter.
-
q=systemDefined:only
Returns roles with the systemDefined parameter set to true.
-
q=systemDefined:none
Returns roles with the systemDefined parameter set to false.
-
q=systemDefined:both
Returns roles with the systemDefined parameter set to true or false.
Example get
response
<role>
<changeStamp>15</changeStamp>
<refURL>/unifiedconfig/config/role/5003</refURL>
<administrators>
<administrator>
<refURL>/unifiedconfig/config/administrator/5002</refURL>
<domainName>BOSTON.COM</domainName>
<userName>userAttribute</userName>
</administrator>
</administrators>
<description>testAttribute</description>
<accessList>
<feature>
<category>agent</category>
<name>attribute</name>
</feature>
<feature>
<category>agent</category>
<name>reasoncode</name>
</feature>
<feature>
<category>call</category>
<name>bucketinterval</name>
</feature>
</accessList>
<name>testAttribute</name>
<systemDefined>false</systemDefined>
</role>