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

# Аутентификация

::: page-constructor
blocks:
  - type: content-layout-block
    textContent:
      buttons:
        - text: Классический VCE
          theme: action
          width: 'auto'
        - text: Документация
          theme: outlined
          url: https://docs.ideco.ru/v22/ru/ngfw/settings/users/authentication/
          width: 'auto'
    resetPaddings: false
    textWidth: l
    size: m
    centered: false
:::

## Управление каталогами аутентификации

{% cut "Получение настроек каталогов аутентификации" %}

```
GET /auth/settings/auth_catalogs
```

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

```json5
{
    "default_catalog_id": "string" | null,
    "local_domain_suffix": "string"
}
```

* `default_catalog_id` - идентификатор каталога по умолчанию, который используется для поиска пользователей при аутентификации:
  * `catalog.id.local` - идентификатор каталога **Локальные пользователи**;
  * `catalog.id.radius` - идентификатор каталога, интегрированный с доменом **RADIUS**;
  * `catalog.id.ad` - идентификатор каталога, интегрированный с доменом **Active Directory**;
  * `catalog.id.ald` - идентификатор каталога, интегрированный с доменом **ALD**;
  * `null` - если каталог не задан.
* `local_domain_suffix` - доменный суффикс. Используется для определения локальных пользователей при аутентификации (если логин содержит указанный суффикс, например, `user@local`) и автоматического отбрасывания суффикса при проверке. Поле заполняется, если по умолчанию в `default_catalog_id` не указан `catalog.id.local`. Может быть пустым.

{% endcut %}

{% cut "Изменение настроек каталогов аутентификации" %}

```
PATCH /auth/settings/auth_catalogs
```

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

```json5
{
    "default_catalog_id": "string",
    "local_domain_suffix": "string"
}
```

* `default_catalog_id` - идентификатор каталога по умолчанию, который используется для поиска пользователей при аутентификации:
  * `catalog.id.local` - идентификатор каталога **Локальные пользователи**;
  * `catalog.id.radius` - идентификатор каталога, интегрированный с доменом **RADIUS**;
  * `catalog.id.ad` - идентификатор каталога, интегрированный с доменом **Active Directory**;
  * `catalog.id.ald` - идентификатор каталога, интегрированный с доменом **ALD**.
* `local_domain_suffix` - доменный суффикс. Используется для определения локальных пользователей при аутентификации (если логин содержит указанный суффикс, например, `user@local`) и автоматического отбрасывания суффикса при проверке. Поле заполняется, если по умолчанию в `default_catalog_id` не указан `catalog.id.local`. Может быть пустым.

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

{% endcut %}

## Управление двухфакторной аутентификацией

{% cut "Получение настройки двухфакторной аутентификации" %}

```
GET /web_authd/control/two_factor/settings
```

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

```json5
{
    "smsaero": {
        "enabled": true | false,
        "login": "string" | null,
        "key": "string" | null,
    },
    "totp": {
        "enabled": true | false,
        "allow_remote_gen_secret": true | false,
    },
    "multifactor": {
        "enabled": true | false,
        "api_key": "string" | null,
        "api_secret": "string" | null,
    }
}
```

* `smsaero` - тип двухфакторной аутентификации **SMS Aero**:
  * `enabled` - статус активности:
    * `true` - включен;
    * `false` - выключен.
  * `login` - логин учетной записи из личного кабинета в SMS Aero;
  * `key` - API-ключ из личного кабинета в SMS Aero. Поля `login` и `key` либо заполняются вместе, либо остаются `null`.
* `totp` - тип двухфакторной аутентификации **TOTP-токен**:
  * `enabled` - статус активности:
    * `true` - включен;
    * `false` - выключен.
  * `allow_remote_gen_secret` - разрешить генерацию секретного ключа из внешних сетей:
    * `true` - разрешено;
    * `false` - запрещено.
* `multifactor` - тип двухфакторной аутентификации **Multifactor**:
  * `enabled` - статус активности:
    * `true` - включен;
    * `false` - выключен.
  * `api_key` - API Key из личного кабинета в Multifactor;
  * `api_secret` - API Secret из личного кабинета в Multifactor.

{% endcut %}

{% cut "Изменение настройки двухфакторной аутентификации" %}

```
PUT /web_authd/control/two_factor/settings
```

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

```json5
{
    "smsaero": {
        "enabled": true | false,
        "login": "string" | null,
        "key": "string" | null,
    },
    "totp": {
        "enabled": true | false,
        "allow_remote_gen_secret": true | false,
    },
    "multifactor": {
        "enabled": true | false,
        "api_key": "string" | null,
        "api_secret": "string" | null,
    }
}
```

* `smsaero` - тип двухфакторной аутентификации **SMS Aero**:
  * `enabled` - статус активности:
    * `true` - включен;
    * `false` - выключен.
  * `login` - логин учетной записи из личного кабинета в SMS Aero;
  * `key` - API-ключ из личного кабинета в SMS Aero. Поля `login` и `key` либо заполняются вместе, либо остаются `null`.
* `totp` - тип двухфакторной аутентификации **TOTP-токен**:
  * `enabled` - статус активности:
    * `true` - включен;
    * `false` - выключен.
  * `allow_remote_gen_secret` - разрешение на генерацию секретного ключа из внешних сетей:
    * `true` - разрешено;
    * `false` - запрещено.
* `multifactor` - тип двухфакторной аутентификации **Multifactor**:
  * `enabled` - статус активности:
    * `true` - включен;
    * `false` - выключен.
  * `api_key` - API Key из личного кабинета в Multifactor;
  * `api_secret` - API Secret из личного кабинета в Multifactor.

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

{% endcut %}