Параметры запроса
Запрос не имеет параметров.
Пример запроса
http://192.168.1.1:9080/api/admins/list.ds
|
Ниже представлены примеры ответов в формате XML и в формате JSON.
Ответ в формате XML
<drweb-es-api api_version="4.3.0" timestamp="1558521888" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
<adm1inistrators total="2">
<administrator id="1" login="adm1" group_id="b3c14d40" 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="2" login="adm2" group_id="b3c14d40" 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
|
Право создавать других администраторов групп
|
permission
|
Предоставление прав доступа. Может принимать следующие значения:
•allow — доступ предоставлен, •deny — доступ запрещен. |
▫Элемент <groups /> содержит информацию обо всех пользовательских группах, которыми управляет администратор. Атрибуты элемента <groups />:
Атрибут
|
Описание
|
total
|
Общее количество пользовательских групп
|
▪Элемент <group /> содержит информацию о конкретной пользовательской группе. Атрибут элемента <group />:
Атрибут
|
Описание
|
id
|
Идентификатор пользовательской группы
|
Значением элемента <group /> является название пользовательской группы.
Ответ в формате JSON
{ "head": {
"status": true,
"timestamp": 1551398630,
"api": {
"version": 40300,
"versionString": 4.3.0},
"server": {
"name": "192.168.1.1",
"version": "12.00.0.201909260",
"uuid": "20546124-e03f-e411-0aa6-a4d5c8ad7f2c"}},
"data": {
"total": 2,
"list": [
{"group_id": "b3c14d40"
"group_name": "Administrators",
"groups": {
"GroupForCAF1-1": "GroupForCAF1-1",
"GroupForCAF1-2": "GroupForCAF1-2"},
"id": "1",
"login": "adm1",
"may_create_admins": true,
"permission": "allow"},
{"group_id": "b3c14d40"
"group_name": "Administrators",
"groups": [],
"id": "2",
"login": "adm2",
"may_create_admins": false,
"permission": "deny"}]}}
|
Описание параметров ответного JSON
Блок data содержит список администраторов во всех административных группах.
Элементы блока data:
Название поля
|
Описание
|
total
|
Общее количество администраторов
|
•Массив list блока data содержит информацию о конкретной учетной записи администратора. Элементы объектов в массиве list:
Название поля
|
Описание
|
id
|
Идентификатор учетной записи
|
login
|
Регистрационное имя учетной записи
|
group_id
|
Идентификатор административной группы
|
group_name
|
Название административной группы
|
may_create_admins
|
Право создавать других администраторов групп
|
permission
|
Предоставление прав доступа. Может принимать следующие значения:
•allow — доступ предоставлен, •deny — доступ запрещен. |
▫Блок groups содержит информацию обо всех пользовательских группах, которыми управляет администратор. Элементы блока groups:
Название поля
|
Описание
|
Идентификатор пользовательской группы
|
Название пользовательской группы
|
|