Параметры запроса
Параметр
|
Описание
|
Обязательный
|
admin_group
|
Идентификатор группы администраторов, права которой унаследует администратор.
|
нет
|
description
|
Описание
|
нет
|
group
|
Идентификатор группы, к которой будет иметь доступ администратор.
Параметр может быть указан в запросе неограниченное количество раз для указания нескольких групп одновременно.
Если этот параметр указан в запросе, то будет создана учетная запись администратора группы.
|
нет
|
id
|
Идентификатор учетной записи администратора.
Допустимые значения: цифры, буквы латинского алфавита, символы ‘_’, ’-‘.
Если идентификатор не задан, то он будет сгенерирован автоматически.
|
нет
|
last-name
|
Фамилия
|
нет
|
login
|
Регистрационное имя учетной записи администратора
|
да
|
may-create-admin
|
Наличие права на создание учетных записей администраторов, групп администраторов.
Допустимые значения: yes | no. По умолчанию: yes.
|
нет
|
middle-name
|
Отчество
|
нет
|
name
|
Имя
|
нет
|
password
|
Пароль.
Если пароль не задан, то он будет сгенерирован автоматически.
|
нет
|
readonly
|
Ограничение прав учетной записи администратора.
Допустимые значения: yes | no. По умолчанию: no.
Если задано значение параметра yes, то будет создана учетная запись с правами только на чтение (см. Приложение А2. Права администратора).
|
нет
|
|
Если одновременно заданы параметры readonly=yes и may-create-admin=yes, то параметр may-create-admin будет игнорироваться. Т. е. администратор с правами только на чтение не может создавать или изменять настройки учетных записей других администраторов.
|
|
Если одновременно заданы параметры admin_group и group, то параметр, заданный последним, будет игнорироваться. Для указания на какую группу антивирусной сети распространяются права данного администратора, выполните запрос изменения параметров администратора: /api/admins/change.ds?id={id администратора}&add-group={id группы антивирусной сети}
|
Пример запроса
https://192.168.1.1:9081/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.2" timestamp="1582030255" server="192.168.1.1" srv_version="13.00.0.202005090" status="true">
<administrator id="20a90c15-ba08-e711-387b-a0568a18dd32"/>
</drweb-es-api>
|
Описание параметров ответного XML
Элемент <administrator /> содержит идентификатор созданной учетной записи администратора.
Атрибут элемента <administrator />:
Атрибут
|
Описание
|
id
|
Идентификатор учетной записи
|
Ответ в формате JSON
{ "head": {
"status": true,
"timestamp": 1582030515,
"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": {
"id": "20a90c15-ba08-e711-387b-a0568a18dd32"}}
|
Описание параметров ответного JSON
Блок data содержит идентификатор созданной учетной записи администратора.
Элемент блока data:
Название поля
|
Описание
|
id
|
Идентификатор учетной записи
|
|