Cisco Unified Contact Center Enterprise Developer Reference Release 10.0(x)
Administrator API
Downloads: This chapterpdf (PDF - 1.08MB) The complete bookPDF (PDF - 2.25MB) | The complete bookePub (ePub - 145.0KB) | The complete bookMobi (Mobi - 238.0KB) | Feedback

Administrator API

Administrator API

An administrator is an Active Directory user who has been provided access to the system.

Use the Administrator API to list the administrators currently defined in the database, define new administrators, and view, edit, and delete existing administrators.

URL

https://<server>/unifiedconfig/config/administrator

Operations

  • create: Creates one administrator.
  • delete: Permanently deletes one administrator.
  • get: Returns one administrator, using the URL https://<server>/unifiedconfig/config/administrator/<id>.
  • list: Retrieves a list of administrators.
  • update: Updates one administrator.

Parameters

  • refURL: The refURL of the administrator. See Shared Parameters.
  • changeStamp: See Shared Parameters.
  • description: See Shared Parameters.
  • userName: Required. The unique username of an existing Active Directory account. Maximum length of 64 characters.
  • domainName: The domain for this administrator. If blank, system uses the default domain name. Maximum length of 64 characters.
  • customer: A reference to a customer, including the refURL.
  • readOnly: Required. Specifies whether the administrator has read-only access to the APIs and tools. 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
  • userName
  • domainName
  • description
  • userName
  • domainName
  • description

See Search and Sort.

Example Get Response

<administrator>
    <changeStamp>0</changeStamp>
    <domainName>domain</domainName>
    <userName>user1</userName>
    <readOnly>false</readOnly>
    <customer>
       <refURL>/unifiedconfig/config/customer/(id)</refURL>
    </customer>
</administrator>