Получение информации об администраторе

Параметры запроса

Параметр

Описание

Примечание

Регистрационное имя учетной записи администратора

Обязательный параметр: да.

Параметр может быть указан в запросе неограниченное количество раз для запроса информации о нескольких администраторах одновременно.

Пример запроса

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

Ниже представлены примеры ответов в формате XML и в формате JSON.

Ответ в формате XML

<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"/>

Описание параметров ответного XML

Элемент <administrators /> содержит информацию обо всех администраторах, регистрационные имена которых переданы в запросе.

Атрибут элемента <administrators />:

Атрибут	Описание
total	Общее количество администраторов, о которых возвращена информация

•Элемент <administrator /> содержит информацию о конкретной учетной записи администратора.

Атрибуты элемента <administrator />:

Атрибут	Описание
id	Идентификатор учетной записи
login	Имя учетной записи
description	Описание
created	Дата и время создания учетной записи в формате Unix timestamp
modified	Дата и время модификации учетной записи в формате Unix timestamp
name	Имя
last_name	Фамилия
middle_name	Отчество
external	Тип авторизации администратора. Значение true — администратор с авторизацией через внешние системы, false — внутренний администратор.
may_create_admin	Право создавать других администраторов групп
group_id	Идентификатор группы, к которой имеет доступ заданный администратор
group_name	Название группы, к которой имеет доступ заданный администратор

Ответ в формате JSON

{ "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"}]}}}

Описание параметров ответного JSON

Блок data содержит информацию о всех администраторах.

Элементы блока data:

Название поля	Описание
total	Общее количество администраторов, о которых возвращена информация

•Массив list содержит информацию о конкретной учетной записи администратора.

Элементы объектов в массиве list:

Название поля	Описание
created_time	Дата и время создания учетной записи в формате Unix timestamp
description	Описание
external	Тип авторизации администратора. Значение true — администратор с авторизацией через внешние системы, false — внутренний администратор.
group_id	Идентификатор группы, к которой имеет доступ заданный администратор
group_name	Название группы, к которой имеет доступ заданный администратор
id	Идентификатор учетной записи
last_name	Фамилия
login	Имя учетной записи
may_create_admins	Право создавать других администраторов групп
middle_name	Отчество
modified_time	Дата и время модификации учетной записи в формате Unix timestamp
name	Имя