Получение списка групп администраторов

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

Запрос не имеет параметров.

 

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

https://192.168.1.1:9081/api/admingroups/list.ds

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

 

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

<drweb-es-api api_version="4.3.2" timestamp="1588503818" server="192.168.1.1" srv_version="13.00.0.202005090" status="true">
  <admin-groups total="5">
     <admin-group id="0d20c3f0-8d2c-11ea-6efe-502672a1498e" parent_id="fe76cc50-8d2b-11ea-6efc-502672a1498e" parent_name="new1" name="new1" description=""/>

     <admin-group id="c11ced50-8ba3-11ea-625e-502672a1498e" parent_id="b3c14d40-9382-4e4f-8edb-5dd52ec04e9d" parent_name="Administrators" name="456" description="new456"/>

     <admin-group id="b3c14d40-9382-4e4f-8edb-5dd52ec04e9d" parent_id="" parent_name="" name="Administrators" description="Root administrator group"/>

     <admin-group id="de8d4d63-6ac1-4161-89fa-5f4ff82e866a" parent_id="" parent_name="" name="Newbies" description="Administrator group for automatically created administrators"/>

     <admin-group id="fe76cc50-8d2b-11ea-6efc-502672a1498e" parent_id="b3c14d40-9382-4e4f-8edb-5dd52ec04e9d" parent_name="Administrators" name="new" description=""/>
  </admin-groups>
</drweb-es-api>

 

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

Элемент <admin-groups /> содержит список групп администраторов.

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

Атрибут

Описание

total

Общее количество групп администраторов

Элемент <admin-group /> содержит параметры конкретной группы администраторов.

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

Атрибут

Описание

id

Идентификатор группы администраторов

parent_id

Идентификатор родительской группы

parent_name

Название родительской группы

name

Название группы администраторов

description

Описание группы администраторов

 

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

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

    "timestamp": 1588504097,

    "api": {
      "version": 40302,
      "versionString": "4.3.2"},

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

      "version": "13.00.0.202005090",
      "uuid": "78b77680-8080-11ea-701a-44a527d9115c"}},

"data": {
    "total": 5,

    "list": [
      {"id": "0d20c3f0-8d2c-11ea-6efe-502672a1498e",

        "name": "new1",

        "parent_id": "fe76cc50-8d2b-11ea-6efc-502672a1498e",
        "parent_name": "new"},

      {"description": "new456",
        "id": "c11ced50-8ba3-11ea-625e-502672a1498e",

        "name": "456",

        "parent_id": "b3c14d40-9382-4e4f-8edb-5dd52ec04e9d",
        "parent_name": "Administrators"},

      {"description": "Root administrator group",
        "id": "b3c14d40-9382-4e4f-8edb-5dd52ec04e9d",

        "name": "Administrators"},

      {"description": "Administrator group for automatically created administrators",
        "id": "de8d4d63-6ac1-4161-89fa-5f4ff82e866a",

        "name": "Newbies"},

      {"id": "fe76cc50-8d2b-11ea-6efc-502672a1498e",

        "name": "new",

        "parent_id": "b3c14d40-9382-4e4f-8edb-5dd52ec04e9d",
        "parent_name": "Administrators"}]}}

 

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

Блок data содержит список администраторов из всех административных групп.

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

Название поля

Описание

total

Общее количество администраторов

list

Массив параметров для каждой учетной записи администратора

Каждый объект массива list содержит параметры конкретной учетной записи администратора.

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

Название поля

Описание

id

Идентификатор учетной записи

login

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

group_id

Идентификатор родительской группы администраторов

group_name

Название родительской группы администраторов

groups

Блок содержит информацию обо всех административных группах, в которые входит администратор

may_create_admins

Наличие права на создание учетных записей администраторов, групп администраторов:

true — право предоставлено,

false — нет права.

permission

Предоставление прав доступа:

allow — доступ предоставлен,

deny — доступ запрещен.

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

Название поля

Описание

Идентификатор группы администраторов

Название группы администраторов