Administrator Information

Request Parameters

Parameter

Description

Note

Administrator account login

Required parameter: yes.

This parameter can be defined in the request several times to request information on multiple administrators at a time.

Request Example

http://192.168.1.1:9080/api/admins/info.ds?login=adm1&login=adm2

XML and JSON response structure examples are described below.

XML Response

<drweb-es-api api_version="4.3.0" timestamp="1555658257" 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="1495654901" modified="1495654901" name="Admin-1" last_name="" middle_name="" external="true" may_create_admin="true" group_id="123" group_name="TEST-GROUP"/>

Description of XML Response Parameters

The <administrators /> element contains information about all administrators whose registration names have been submitted in the request.

The <administrators /> element attribute:

Attribute	Description
total	Total number of administrators about which the information have been returned

•The <administrator /> element contains information about a specific administrator account.

The <administrator /> element attributes:

Attribute	Description
id	Account identifier
login	Account login
description	Description
created	Account creation time and date in Unix timestamp format
modified	Account modification time and date in Unix timestamp format
name	Name
last_name	Surname
middle_name	Middle name
external	The type of administrator authorization. False value means internal administrator, while true stands for administrator with authorization via the external systems.
may_create_admin	Right to create other group administrators
group_id	Identifier of a group which a specified administrator can access
group_name	Name of a group which a specified administrator can access

JSON Response Structure

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

"timestamp": 1550514584,

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

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

"version": "12.00.0.201909260",
"uuid": "70c5f522-aaab-4c93-a180-a442a0da9c2a"}},

"data": {
"admins": {
"total": 1,

"list": [
{"created_time": 1495654901,

"description": "Default administrator account",

"external": true,

"group_id": "123",

"group_name": "TEST-GROUP",

"id": "1",

"last_name": null,

"login": "adm1",

"may_create_admins": true,

"middle_name": null,

"modified_time": 1495654901,
"name": "Admin-1"},

{"created_time": 1495655048,
"description": "",

"external": false,

"group_id": "777",

"group_name": "NEW-GROUP",

"id": "2",
"last_name": null,

"login": "adm2",

"may_create_admins": false,

"middle_name": null,

"modified_time": 1495655114,
"name": "Admin-2"}]}}}

Description of JSON Response Parameters

The data block contains information about all administrators.

The data block elements:

Field name	Description
total	Total number of administrators about which the information have been returned

•The list array contains information about a specific administrator account.

Elements in the list array:

Field name	Description
created_time	Account creation time and date in Unix timestamp format
description	Description
external	The type of administrator authorization. False value means internal administrator, while true stands for administrator with authorization via the external systems.
group_id	Identifier of a group which a specified administrator can access
group_name	Name of a group which a specified administrator can access
id	Account identifier
last_name	Surname
login	Account login
may_create_admins	Right to create other group administrators
middle_name	Middle name
modified_time	Account modification time and date in Unix timestamp format
name	Name