Get Administrator Information

Request Parameter

Parameter

Description

Mandatory

login

Administrator account login.

This parameter can be repeated any number of times per request to request information about multiple administrators at a time.

yes

 

Request Example

https://192.168.1.1:9081/api/admins/info.ds?login=adm1&login=adm2

XML and JSON response structure examples are described below.

 

XML Response Structure

<drweb-es-api api_version="4.3.0" timestamp="1582030256" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
  <administrators total="2">
     <administrator id="1" login="adm1" description="Default administrator account" created="1582030256" modified="1582030256" name="Admin-1" last_name="" middle_name="" external="true" may_create_admin="true" group_id="b3c14d40-9382-4e4f-8edb-5dd52ec04e9d" group_name="Administrators"/>

     <administrator id="2" login="adm2" description="" created="1582030256" modified="1582030256" name="Admin-2" last_name="" middle_name="" external="false" may_create_admin="false" group_id="777" group_name="NEW-GROUP"/>
  </administrators>
</drweb-es-api>

 

Description of XML Response Parameters

The <administrators /> element contains information about administrator accounts that were specified in the request.

The <administrators /> element attribute:

Attribute

Description

total

Total number of administrator accounts in the response

The <administrator /> element contains parameters of a specific administrator account.

The <administrator /> element attributes:

Attribute

Description

id

Account ID

login

Account login

description

Description

created

Account creation time and date

modified

Account modification time and date

name

Name

last_name

Surname

middle_name

Middle name

external

Administrator authorization type:

true—administrator authorized via external systems,

false—internal administrator.

may_create_admin

Authorization to create administrator accounts, administrator groups:

true—authorized,

false—not authorized.

group_id

ID of a group an administrator has access to

group_name

Name of a group an administrator has access to

 

JSON Response Structure

{ "head": {
    "status": true,

    "timestamp": 1582030514,

    "api": {
      "version": 40300,
      "versionString": 4.3.0},

    "server": {
      "name": "192.168.1.1",

      "version": "12.00.0.201909260",
      "uuid": "eae1a652-96d5-48fd-9169-4788a03688b8"}},

"data": {
    "admins": {
      "total": 2,

      "list": [
          {"id": "1",
          "login": "adm1",

          "description": "Default administrator account",

          "created_time": 1582030513,

          "modified_time": 1582030513,

          "name": "Admin-1",

          "last_name": null,

          "middle_name": null,

          "external": true,

          "may_create_admins": true,

          "group_id": "b3c14d40-9382-4e4f-8edb-5dd52ec04e9d",
          "group_name": "Administrators"},

          {"id": "2",
          "login": "adm2",

          "description": "",

          "created_time": 1582030513,

          "modified_time": 1582030513,

          "name": "Admin-2",

          "last_name": null,

          "may_create_admins": false,

          "middle_name": null,

          "external": false,

          "group_id": "777",
          "group_name": "NEW-GROUP"}]}}}

 

Description of JSON Response Parameters

The data block contains information about administrator accounts that were specified in the request.

The data block elements:

Field name

Description

total

Total number of administrator accounts in the response

list

Array of parameters for each administrator account

Each object of the list array contains parameters of a specific administrator account.

Elements in the list array:

Field name

Description

id

Account ID

login

Account login

description

Description

created_time

Account creation time and date

modified_time

Account modification time and date

name

Name

last_name

Surname

middle_name

Middle name

external

Administrator authorization type:

true—administrator authorized via external systems,

false—internal administrator.

may_create_admins

Authorization to create administrator accounts, administrator groups:

true—authorized,

false—not authorized.

group_id

ID of a group an administrator has access to

group_name

Name of a group an administrator has access to