Role API

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>/unifiedconfig/config/role

Operations

Parameters

Search and Sort Values

The following table shows the parameters that are searched and the parameters that are sortable.

Search parameters Sort parameters
  • name
  • description
  • 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>