|
Параметр запроса
Параметр
|
Описание
|
Обязательный
|
login
|
Регистрационное имя учетной записи администратора.
Параметр может быть указан в запросе неограниченное количество раз для запроса информации о нескольких администраторах одновременно.
|
да
|
Пример запроса
https://192.168.1.1:9081/api/admins/info.ds?login=adm1&login=adm2
|
Ниже представлены примеры ответов в формате XML и в формате JSON.
Ответ в формате XML
<drweb-es-api api_version="4.3.2" timestamp="1582030256" server="192.168.1.1" srv_version="13.00.1.202310121" 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>
|
Описание параметров ответного XML
Элемент <administrators /> содержит информацию об учетных записях администраторов, указанных в запросе.
Атрибут элемента <administrators />:
Атрибут
|
Описание
|
total
|
Общее количество учетных записей администраторов в ответе
|
•Элемент <administrator /> содержит параметры конкретной учетной записи администратора.
Атрибуты элемента <administrator />:
Атрибут
|
Описание
|
id
|
Идентификатор учетной записи
|
login
|
Регистрационное имя учетной записи
|
description
|
Описание
|
created
|
Дата и время создания учетной записи
|
modified
|
Дата и время модификации учетной записи
|
name
|
Имя
|
last_name
|
Фамилия
|
middle_name
|
Отчество
|
external
|
Тип авторизации администратора:
•true — администратор с авторизацией через внешние системы,
•false — внутренний администратор. |
may_create_admin
|
Наличие права на создание учетных записей администраторов, групп администраторов:
•true — право предоставлено,
•false — нет права. |
group_id
|
Идентификатор группы, к которой имеет доступ администратор
|
group_name
|
Название группы, к которой имеет доступ администратор
|
Ответ в формате JSON
{ "head": {
"status": true,
"timestamp": 1582030514,
"api": {
"version": 40302,
"versionString": "4.3.2"},
"server": {
"name": "192.168.1.1",
"version": "13.00.1.202310121",
"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"}]}}}
|
Описание параметров ответного JSON
Блок data содержит информацию об учетных записях администраторов, указанных в запросе.
Элементы блока data:
Название поля
|
Описание
|
total
|
Общее количество учетных записей администраторов в ответе
|
list
|
Массив параметров для каждой учетной записи администратора
|
•Каждый объект массива list содержит параметры конкретной учетной записи администратора.
Элементы объектов в массиве list:
Название поля
|
Описание
|
id
|
Идентификатор учетной записи
|
login
|
Регистрационное имя учетной записи
|
description
|
Описание
|
created_time
|
Дата и время создания учетной записи
|
modified_time
|
Дата и время модификации учетной записи
|
name
|
Имя
|
last_name
|
Фамилия
|
middle_name
|
Отчество
|
external
|
Тип авторизации администратора:
•true — администратор с авторизацией через внешние системы,
•false — внутренний администратор. |
may_create_admins
|
Наличие права на создание учетных записей администраторов, групп администраторов:
•true — право предоставлено,
•false — нет права. |
group_id
|
Идентификатор группы, к которой имеет доступ администратор
|
group_name
|
Название группы, к которой имеет доступ администратор
|
|