Administrator API

An administrator is an Active Directory user who has been provided access to the system. That access can be controlled by assigning the administrator to roles and departments (see Role API and Department API) .

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>:<serverport>/unifiedconfig/config/administrator

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
  • userName
  • domainName
  • description
  • userName
  • domainName
  • description

See Search and Sort.

Example get response

<administrator>
      <changeStamp>3</changeStamp>
      <refURL>/unifiedconfig/config/administrator/5000</refURL>
      <domainName>domain</domainName>
      <userName>user1</userName>
      <departments>
        <department>
          <refURL>/unifiedconfig/config/department/5000</refURL>
          <name>dept1</name>
        </department>
        <department>
          <refURL>/unifiedconfig/config/department/5001</refURL>
          <name>dept2</name>
        </department>
      </departments>
      <description>desc</description>
      <readOnly>true</readOnly>
      <role>
        <refURL>/unifiedconfig/config/role/5005</refURL>
        <name>ConfigAdmin</name>
      </role>
</administrator>