Добавление администратора

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

Параметр

Описание

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

Примечание

description

Описание

–

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

group

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

–

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

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

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 является приоритетным. Т. е. администратор с правами только на чтение не может создавать или изменять настройки учетных записей других администраторов.

 

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

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

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

 

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

<drweb-es-api api_version="4.3.0" timestamp="1558521886" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
  <administrator id="f143cc19-e71c-4ec5-b32c-0fc8f4b41706"/>
</drweb-es-api>

 

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

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

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

Атрибут

Описание

id

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

 

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

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

    "timestamp": 1558521886,

    "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": "afbff760-4746-449a-af4b-4e9fd43ffc59"}}

 

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

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

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

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

Описание

id

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