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.
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.
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>.
list: Retrieves a list of roles.
update: Gets the role item and updates the new configuration entered in the <accessList> fields.
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.
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.
The following table shows the parameters that are searched and the parameters that are sortable.
Advanced search parameters
<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>