|
Параметры запроса
Запрос не имеет параметров.
Пример запроса
https://192.168.1.1:9081/api/admins/list.ds
|
Ниже представлены примеры ответов в формате XML и в формате JSON.
Ответ в формате XML
<drweb-es-api api_version="4.3.2" timestamp="1582030266" server="192.168.1.1" srv_version="13.00.0.202005090" status="true">
<adm1inistrators total="2">
<administrator id="admin1" login="adm1" group_id="b3c14d40-9382-4e4f-8edb-5dd52ec04e9d" group_name="Administrators" may_create_admin="true" permission="allow"/>
<groups>
<group id="GroupForCAF1-1">GroupForCAF1-1</group>
<group id="GroupForCAF1-2">GroupForCAF1-2</group>
</groups>
</administrator>
<administrator id="admin2" login="adm2" group_id="b3c14d40-9382-4e4f-8edb-5dd52ec04e9d" group_name="Administrators" may_create_admin="false" permission="deny"/>
<groups> </groups>
</administrator>
</administrators>
</drweb-es-api>
|
Описание параметров ответного XML
Элемент <administrators /> содержит список администраторов из всех административных групп.
Атрибут элемента <administrators />:
Атрибут
|
Описание
|
total
|
Общее количество администраторов
|
•Элемент <administrator /> содержит параметры конкретной учетной записи администратора.
Атрибуты элемента <administrator />:
Атрибут
|
Описание
|
group_id
|
Идентификатор группы
|
group_name
|
Название группы
|
id
|
Идентификатор учетной записи
|
login
|
Регистрационное имя учетной записи
|
may_create_admin
|
Наличие права на создание учетных записей администраторов, групп администраторов:
•true — право предоставлено,
•false — нет права. |
permission
|
Предоставление прав доступа:
•allow — доступ предоставлен,
•deny — доступ запрещен. |
▫Элемент <groups /> содержит информацию обо всех административных группах, в которые входит администратор.
Атрибут элемента <groups />:
Атрибут
|
Описание
|
total
|
Общее количество групп администраторов
|
▪Элемент <group /> содержит информацию о конкретной группе администраторов.
Атрибут элемента <group />:
Атрибут
|
Описание
|
id
|
Идентификатор группы администраторов
|
Значением элемента <group /> является название группы администраторов.
Ответ в формате JSON
{ "head": {
"status": true,
"timestamp": 1582030523,
"api": {
"version": 40302,
"versionString": "4.3.2"},
"server": {
"name": "192.168.1.1",
"version": "13.00.0.202005090",
"uuid": "eae1a652-96d5-48fd-9169-4788a03688b8"}},
"data": {
"total": 2,
"list": [
{"group_id": "b3c14d40-9382-4e4f-8edb-5dd52ec04e9d"
"group_name": "Administrators",
"groups": {
"GroupForCAF1-1": "GroupForCAF1-1",
"GroupForCAF1-2": "GroupForCAF1-2"},
"id": "admin1",
"login": "adm1",
"may_create_admins": true,
"permission": "allow"},
{"group_id": "b3c14d40-9382-4e4f-8edb-5dd52ec04e9d"
"group_name": "Administrators",
"groups": [],
"id": "admin2",
"login": "adm2",
"may_create_admins": false,
"permission": "deny"}]}}
|
Описание параметров ответного JSON
Блок data содержит список администраторов из всех административных групп.
Элементы блока data:
Название поля
|
Описание
|
total
|
Общее количество администраторов
|
list
|
Массив параметров для каждой учетной записи администратора
|
•Каждый объект массива list содержит параметры конкретной учетной записи администратора.
Элементы объектов в массиве list:
Название поля
|
Описание
|
id
|
Идентификатор учетной записи
|
login
|
Регистрационное имя учетной записи
|
group_id
|
Идентификатор группы
|
group_name
|
Название группы
|
groups
|
Блок содержит информацию обо всех административных группах, в которые входит администратор
|
may_create_admins
|
Наличие права на создание учетных записей администраторов, групп администраторов:
•true — право предоставлено,
•false — нет права. |
permission
|
Предоставление прав доступа:
•allow — доступ предоставлен,
•deny — доступ запрещен. |
▫Элементы блока groups:
Название поля
|
Описание
|
Идентификатор группы администраторов
|
Название группы администраторов
|
|