---
canonical: https://docs.ideco.ru/v22/ru/ngfw/api/local-admins-api
---



# Локальные администраторы

::: page-constructor
blocks:
  - type: content-layout-block
    textContent:
      buttons:
        - text: Классический VCE
          theme: action
          width: 'auto'
        - text: Высокопроизводительный VCE
          theme: outlined
          url: https://docs.ideco.ru/api/vpp-v22/ru/ngfw/server-management/admins/local-admins-api/
          width: 'auto'
        - text: Документация
          theme: outlined
          url: https://docs.ideco.ru/v22/ru/ngfw/settings/server-management/admins
          width: 'auto'
    resetPaddings: false
    textWidth: l
    size: m
    centered: false
:::

{% cut "Получение списка локальных администраторов" %}

```
GET /web/admins/local?format_type=JSON|CSV&columns=["id","name", ...]
```

* `format_type` - поддерживается `CSV` и `JSON`, по умолчанию `JSON`;
* `columns` - список столбцов, которые попадут в `CSV` отчет, по умолчанию пустой список.

Список `columns` состоит из столбцов (значения столбцов описаны ниже):

* `id`
* `name`
* `enabled`
* `login`
* `role`
* `comment`
* `password_timestamp`

**Ответ на успешный запрос в формате JSON:**

```json5
[
    {
        "id": "string",
        "enabled": true | false,
        "name": "string",
        "login": "string",
        "role": "string",
        "ssh_login_by_key": true | false,
        "ssh_public_key": "string",
        "comment": "string",
        "password_timestamp": "integer",
        "two_factor": "string"
    },
    ...
]
```

**Ответ на успешный запрос в формате CSV:**

```
id,name,enabled,login,role,comment,password_timestamp
8aa49b1f-5711-4e5e-ab66-4828c6785b84,Administrator,True,administrator,predefined_admin_write,Создано через cloud-init.,1724047828
8aa49b1f-5711-4e5e-ab66-4828c6785b92,Admin,True,administrator,predefined_security_admin,Главный администратор,1724047850
```

* `id` - идентификатор администратора;
* `enabled` - состояние аккаунта администратора:
  * `true` - включен;
  * `false` - выключен.
* `name` - имя администратора;
* `login` - логин администратора;
* `role` - идентификатор уровня доступа аккаунта:
    * `predefined_admin_write` - администратор (полный доступ к настройке);
    * `predefined_admin_readonly` - только просмотр;
    * `predefined_reports_view` - просмотр отчетов;
    * `predefined_reports_change` - создание отчетов (доступно создание шаблонов, расписание отправки и просмотр отчетов);
    * `predefined_security_admin` - администратор ИБ (работа с событиями безопасности);
    * `predefined_firewall_admin` - администратор межсетевого экрана (создание учетных записей, работа с правилами фильтрации, управление режимами работы межсетевого экрана);
    * `predefined_access_settings_admin` - администратор настройки доступов (настройки сетевого взаимодействия пользователей межсетевого экрана, субъектов доступа, информационных систем).
* `ssh_login_by_key` - признак входа по SSH-ключу:
  * `true` - только по ключу;
  * `false` - только по паролю.
* `ssh_public_key` - публичный SSH-ключ. Максимальная длина - 739 символов. Может быть пустым;
* `comment` - комментарий. Максимальная длина - 255 символов. Может быть пустым;
* `two_factor` - двухфакторная аутентификация с типом `admin_2fa`. Может быть пустым;
* `password_timestamp` - время последнего успешного изменения пароля.

{% endcut %}

{% cut "Добавление локального администратора" %}

```
POST /web/admins/local
```

**Json-тело запроса:**

```json5
{
    "enabled": true | false,
    "name": "string",
    "login": "string",
    "password": "string",
    "role": "string",
    "ssh_login_by_key": true | false,
    "ssh_public_key": "string",
    "comment": "string",
    "two_factor": "string"
}
```

* `enabled` - состояние аккаунта администратора:
  * `true` - включен;
  * `false` - выключен.
* `name` - имя, обязательное поле, длина от 1 до 42 символов;
* `login` - логин, обязательное поле, не должен начинаться с цифры, содержать специальные и пробельные символы, кроме дефиса `-`. Длина от 1 до 31 символа;
* `password` - пароль, обязательное поле, длина от 12 до 42 символов. Должен содержать строчные и заглавные латинские буквы, цифры и специальные символы (! # $ % & ' * + и другие);
* `role` - идентификатор уровня доступа аккаунта:
    * `predefined_admin_write` - администратор (полный доступ к настройке);
    * `predefined_admin_readonly` - только просмотр;
    * `predefined_reports_view` - просмотр отчетов;
    * `predefined_reports_change` - создание отчетов (доступно создание шаблонов, расписание отправки и просмотр отчетов);
    * `predefined_security_admin` - администратор ИБ (работа с событиями безопасности);
    * `predefined_firewall_admin` - администратор межсетевого экрана (создание учетных записей, работа с правилами фильтрации, управление режимами работы межсетевого экрана);
    * `predefined_access_settings_admin` - администратор настройки доступов (настройки сетевого взаимодействия пользователей межсетевого экрана, субъектов доступа, информационных систем).
* `ssh_login_by_key` - признак входа по SSH-ключу:
  * `true` - только по ключу;
  * `false` - только по паролю.
* `ssh_public_key` - публичный SSH-ключ. Максимальная длина - 739 символов. Может быть пустым;
* `comment` - комментарий. Максимальная длина - 255 символов. Может быть пустым;
* `two_factor` - двухфакторная аутентификация с типом `admin_2fa`. Может быть пустым.

**Ответ на успешный запрос:**

```json5
{
    "id": "string"
}
```

* `id` - идентификатор администратора.

{% endcut %}

{% cut "Изменение настроек и пароля локального администратора" %}

```
PATCH /web/admins/local/<id администратора>
```

**Json-тело запроса:**

```json5
{
    "enabled": true | false,
    "name": "string",
    "login": "string",
    "password": "string",
    "role": "string",
    "ssh_login_by_key": true | false,
    "ssh_public_key": "string",
    "comment": "string",
    "two_factor": "string"
}
```

**Ответ на успешный запрос:** 200 ОК

* `enabled` - состояние аккаунта администратора:
  * `true` - включен;
  * `false` - выключен.
* `name` - имя, обязательное поле, длина от 1 до 42 символов;
* `login` - логин, обязательное поле, не должен начинаться с цифры, содержать специальные и пробельные символы, кроме дефиса `-`. Длина от 1 до 31 символа;
* `password` - пароль, обязательное поле, длина от 12 до 42 символов. Должен содержать строчные и заглавные латинские буквы, цифры и специальные символы (! # $ % & ' * + и другие);
* `role` - идентификатор уровня доступа аккаунта:
    * `predefined_admin_write` - администратор (полный доступ к настройке);
    * `predefined_admin_readonly` - только просмотр;
    * `predefined_reports_view` - просмотр отчетов;
    * `predefined_reports_change` - создание отчетов (доступно создание шаблонов, расписание отправки и просмотр отчетов);
    * `predefined_security_admin` - администратор ИБ (работа с событиями безопасности);
    * `predefined_firewall_admin` - администратор межсетевого экрана (создание учетных записей, работа с правилами фильтрации, управление режимами работы межсетевого экрана);
    * `predefined_access_settings_admin` - администратор настройки доступов (настройки сетевого взаимодействия пользователей межсетевого экрана, субъектов доступа, информационных систем).
* `ssh_login_by_key` - признак входа по SSH-ключу:
  * `true` - только по ключу;
  * `false` - только по паролю.
* `ssh_public_key` - публичный SSH-ключ. Максимальная длина - 739 символов. Может быть пустым;
* `comment` - комментарий. Максимальная длина - 255 символов. Может быть пустым;
* `two_factor` - двухфакторная аутентификация с типом `admin_2fa`. Может быть пустым.

**При смене пароля или отключении аккаунта веб-сессии удаляются.**

{% endcut %}

{% cut "Удаление локального администратора" %}

**Последнего локального администратора удалять нельзя!**

```
DELETE /web/admins/local/<id администратора>
```

**Ответ на успешный запрос:** 200 OK

{% endcut %}
