Изменение параметров администратора

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

Параметр

Описание

Допустимые значения

Примечание

add-group

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

–

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

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

delete-group

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

–

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

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

description

Описание

–

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

id

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

–

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

last-name

Фамилия

–

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

login

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

–

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

may-create-admin

Флаг, определяющий наличие права на создание администраторов, групп администраторов

yes | no

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

Значение по умолчанию yes

middle-name

Отчество

–

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

name

Имя

–

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

password

Пароль

–

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

readonly

Флаг для ограничения прав учетной записи администратора

yes | no

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

Значение по умолчанию no.
Если задано значение yes, то учетная запись будет иметь права только на чтение (см. в разделе Права).

Если одновременно заданы параметры readonly=yes и may-create-admin=yes, то параметр readonly является приоритетным. Т. е. администратор с правами только на чтение не может создавать или изменять настройки учетных записей других администраторов.

 

Администратор не может изменять параметры may-create-admin, readonly и group для своей учетной записи.

 

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

http://192.168.1.1:9080/api/admins/change.ds?id=3&login=newadm3&password=root&name=name&last-name=last-name&middle-name=middle-name&description=description&add-group=1&readonly=yes&may-create-admin=no

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

 

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

<drweb-es-api api_version="4.3.0" timestamp="1558521887" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
  <administrator id="3"/>
</drweb-es-api>

 

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

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

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

Атрибут

Описание

id

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

 

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

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

    "timestamp": 1558521969,

    "api": {
      "version": 40300,
      "versionString": 4.3.0},

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

      "version": "12.00.0.201909260",
      "uuid": "27671337-e0b0-4f60-aeb0-ab1f2ca47f77"}},

"data": {
    "id": "3"}}

 

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

Блок data содержит информацию о измененной учетной записи администратора.

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

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

Описание

id

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