---
canonical: https://docs.ideco.ru/v22/ru/ngfw/api/reports-auth-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/stat-api/auth-log/
          width: 'auto'
        - text: Документация
          theme: outlined
          url: https://docs.ideco.ru/v22/ru/ngfw/settings/reports/authorization-log
          width: 'auto'
    resetPaddings: false
    textWidth: l
    size: m
    centered: false
:::

{% cut "Получение авторизованных пользователей" %}{#poluchenie-avtorizovannyh-polzovateley}

```
GET /auth/log?<GET-параметры, разделенные знаком &>
```

Перечень GET-параметров:
* `limit: integer` - ограничение на количество записей, выбираемых из базы данных;
* `offset: integer` - количество строк, которые нужно пропустить перед выводом записей из `limit`;
* `sort: [{"field": "string", "direction": "asc | desc"}]` - список параметров сортировки. Сортировка производится в прямом порядке следования в массиве:
    * `field` - столбец, по которому производится сортировка;
    * `direction` - направление сортировки: `asc` - по возрастанию, `desc` - по убыванию.
* `format_type` - формат данных, поддерживает `CSV` и `JSON`, по умолчанию `JSON`.

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

```json5
{
  "meta": [
    {
      "name": "string",
      "type": "string"
    }
  ],
  "data": [
    {
       "id": "string",
       "auth_module": "string",
       "external_ip": "string",
       "end": "YYYYMMDDhhmmss integer",
       "login": "string",
       "mac": "string",
       "name": "string",
       "start": "YYYYMMDDhhmmss integer",
       "time_online": "integer",
       "subnet": "string",
       "user_object_id": "string",
       "user_session_id": "string",
       "domain_type": "string",
       "group_name": "string",
       "group_object_id": "string",
       "country_name": "string",
       "country_code": "string",
       "device_name": "string",
       "mcert_dn": "string",
       "mcert_ca_id": "string",
       "mcert_ca_dn": "string",
       "mcert_binding": true | false,
       "hip_profiles": ["string"],
       "hip_profiles_changes": "integer",
       "vce_id": "string",
       "vce_name": "string",
       "node_id": "string",
       "node_name": "string",
       "cluster_id": "string",
       "cluster_name": "string",
       "version": "string",
       "hwid": "string",
       "hostname": "string"
     }
  ],
  "rows": "integer",
  "rows_before_limit_at_least": "integer"
}
```

* `meta` - массив метаданных, описывающих поля запроса:
  * `name` - имя поля данных;
  * `type` - тип данных.
* `data` - массив из `AuthUser` для отображения в таблице. `AuthUser` - объект с данными, соответствующими одной строке таблицы:
  * `id` - идентификатор сессии;
  * `auth_module` - тип авторизации:
    * `agent-ng` - авторизация через Ideco Client без туннеля (из локальной сети);
    * `agent-vpn-tls` - авторизация через Ideco Client (TLS);
    * `agent-vpn-ng` - авторизация через Ideco Client (Wireguard);
    * `ip` - авторизация по IP;
    * `ip_permanent` - постоянная авторизация по IP;
    * `mac` - авторизация по MAC;
    * `ip_and_mac` - авторизация по IP+MAC;
    * `ip_and_mac_permanent` - постоянная авторизация по IP+MAC;
    * `web` - веб-авторизация;
    * `log` - авторизация через журналы AD;
    * `agent` - авторизация через Ideco агент (поддерживалась до 15 версии NGFW Novum);
    * `ideco-vpn` - авторизация через Ideco VPN (поддерживалась до 12 версии NGFW Novum);
    * `win-terminal-agent` - авторизация терминального сервера Windows;
    * `win-terminal-user` - авторизация пользователя терминального сервера Windows;
    * `pptp` - авторизация по PPTP;
    * `l2tp` - авторизация по L2TP;
    * `pppoe` - авторизация по PPPoE;
    * `sstp` - авторизация по SSTP;
    * `ikev2` - авторизация по IKEv2;
    * `net` - авторизация по подсети.
  * `external_ip` - IP-адрес пользователя, подключенного по VPN. Строка пустая, если подключение не по VPN или IP-адрес не определен;
  * `end` - время удаления сессии, число в формате `YYYYMMDDhhmmss`;
  * `login` - логин пользователя;
  * `mac` - MAC-адрес;
  * `name` - имя пользователя;
  * `start` - время создания сессии, число в формате `YYYYMMDDhhmmss`;
  * `time_online` - время в сети, в секундах. Может быть отрицательным числом, если после старта сессии изменилось время;
  * `subnet` - подсеть пользователя;
  * `user_object_id` - идентификатор пользователя в формате с префиксом;
  * `user_session_id` - идентификатор сессии пользователя;
  * `domain_type` - тип пользователя. Поле может быть пустым для записей, созданных до 17 версии Ideco NGFW Novum:
    * `local` - локальный пользователь Ideco NGFW Novum;
    * `ad` - пользователь, импортированный из Active Directory;
    * `ald` - пользователь, импортированный из ALD Pro;
    * `freeipa` - пользователь, импортированный из FreeIPA;
    * `radius` - пользователь RADIUS-сервера;
    * `device` - клиентское устройство, подключающееся через Ideco Client в режиме Device VPN.
  * `group_name` - название родительской группы пользователя. Поле может быть пустым для записей, созданных до 17 версии Ideco NGFW Novum;
  * `group_object_id` - идентификатор группы с префиксом. Поле может быть пустым для записей, созданных до 17 версии Ideco NGFW Novum;
  * `country_name` - страна IP-адреса. Cтрока пустая, если не удалось определить местоположение;
  * `country_code` - код страны IP-адреса. Cтрока пустая, если не удалось определить местоположение;
  * `device_name` - имя устройства, полученное от Ideco Client. Cтрока пустая, если проверка не выполнялась;
  * `mcert_dn` - DN сертификата устройства. Строка пустая, если сертификат не использовался;
  * `mcert_ca_id` - идентификатор УЦ сертификата устройства. Строка пустая, если сертификат не использовался;
  * `mcert_ca_dn` - DN УЦ сертификата устройства. Строка пустая, если сертификат не использовался;
  * `mcert_binding` - привязка CA-сертификата устройства к пользователю:
    * `true` - включена;
    * `false` - выключена.
  * `hip_profiles` - список идентификаторов HIP-профилей, которым соответствует устройство. Массив может быть пустым, если проверка не выполнялась;
  * `hip_profiles_changes` - счетчик изменения HIP-профилей. Для сессий, авторизованных через Ideco Client, всегда больше нуля. Для остальных сессий равен нулю;
  * `vce_id` - идентификатор VCE;
  * `vce_name` - название VCE;
  * `node_id` - идентификатор ноды кластера;
  * `node_name` - название ноды кластера;
  * `cluster_id` - идентификатор кластера;
  * `cluster_name` - название кластера;
  * `version` - версия NGFW Novum;
  * `hwid` - аппаратный идентификатор устройства;
  * `hostname` - имя хоста NGFW Novum.
* `rows` - количество объектов `data`;
* `rows_before_limit_at_least` - общее количество строк без учета `limit` и `offset`. Если в параметрах запроса отсутствуют `limit` и `offset`, поле `rows_before_limit_at_least` в ответе на запрос будет отсутствовать.

{% endcut %}

{% cut "Получение уникальных значений полей" %}

```
GET /auth/log/unique/<field_name>
```
Возможные значения `field_name`:

* `auth_module` - тип авторизации:
  * `agent-ng` - подключение через Ideco Client без туннеля (из локальной сети);
  * `agent-vpn-ng` - подключение по Wireguard (Ideco Client);
  * `agent-vpn-tls` - подключение по TLS (Ideco Client);
  * `agent` - подключение через Ideco агент;
  * `ideco-vpn` - подключение через Ideco VPN;
  * `ikev2` - подключение по IKEv2;
  * `ip_and_mac_permanent` - постоянная авторизация по IP+MAC;
  * `ip_and_mac` - авторизация по IP+MAC;
  * `ip_permanent` - постоянная авторизация по IP;
  * `ip` - авторизация по IP;
  * `l2tp` - подключение по L2TP;
  * `log` - авторизация через журналы AD;
  * `mac` - авторизация по MAC;
  * `net` - авторизация по подсети;
  * `sstp` - подключение по SSTP;
  * `web` - веб-авторизация;
  * `win-terminal-agent` - авторизация терминального сервера Windows;
  * `win-terminal-user` - авторизация пользователя терминального сервера Windows.
* `external_ip` - IP-адрес пользователя, подключенного по VPN;
* `subnet` - подсеть пользователя;
* `country_name` - страна IP-адреса;
* `device_name` - имя устройства, полученное от Ideco Client. Cтрока пустая, если проверка не выполнялась;
* `hip_profiles` - список идентификаторов HIP-профилей, которым соответствует устройство;
* `vce_id` - идентификатор VCE;
* `vce_name` - название VCE;
* `node_id` - идентификатор ноды кластера;
* `node_name` - название ноды кластера;
* `cluster_id` - идентификатор кластера;
* `cluster_name` - название кластера;
* `version` - версия NGFW Novum;
* `hwid` - аппаратный идентификатор устройства;
* `hostname` - имя хоста NGFW Novum.

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

```json5
{
  "field_name": ["value"]
}
```

* `field_name` - поле, для которого запрашиваются уникальные значения; 
* `value` - массив уникальных значений.

{% endcut %}

{% cut "Выгрузка данных в CSV за определенный период" %}

```
GET /auth/log?format_type=CSV&<GET-параметры, разделенные знаком &>`
```

Перечень GET-параметров:

* `limit: integer` - ограничение на количество записей, выбираемых из базы данных;
* `offset: integer` - количество строк, которые нужно пропустить перед выводом записей из `limit`;
* `sort: [{"field": "string", "direction": "asc | desc"}]` - список параметров сортировки. Сортировка производится в прямом порядке следования в массиве:
    * `field` - столбец, по которому производится сортировка;
    * `direction` - направление сортировки: `asc` - по возрастанию, `desc` - по убыванию.
* `format_type` - формат данных. Поддерживает `CSV` и `JSON`, по умолчанию `JSON`.

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

{% endcut %}

{% cut "Информация об устройстве и результат проверки по HIP-объектам" %}{#informaciya-ob-ustroystve-i-rezultat-proverki-po-hip-obektam}

```
GET /ztna/checks
```

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

```json5
{
  "check_id": "string",
  "check": "int",
  "start": "int",
  "id": "string",
  "ztna_info": {
    "node_name": "string|null",
    "operation_system": {
      "type": "string",
      "version": "string",
      "domain": "string"
    },
    "kb_list": ["string"],
    "antivirus": [
      {
        "active": true | false,
        "name": "string", 
        "version": "string",
        "last_update": "integer|null",
        "last_scan": "integer|null"
      },
    ], 
    "firewall": [
      {
        "active": true | false,
        "name": "string",
        "version": "string",
      },
    ],
    "proc_list": ["string"],
    "service_list": ["string"], 
    "reg_key_list": [
      {
        "key": "string",
        "value": "string",
      }
    ],
  },
  "hip_profiles": ["string"],
  "hip_objects": [
    {
      "hip_object": "string",
      "is_match": true | false,
    },
    ...
  ],  
}
```

* `check_id` - идентификатор проверки ZTNA информации;
* `check` - время изменения ZTNA информации, число в формате `YYYYMMDDhhmmss`;  
* `start` - время авторизации пользователя с помощью Ideco Client, целое положительное число в формате `YYYYMMDDhhmmss`;
* `id` - идентификатор сессии;
* `ztna_info` - собранная с помощью Ideco Client информация об устройстве:
  * `node_name` - имя узла. Пустая строка, если проверка не выполнялась;
  * `operation_system` - результаты проверки ОС:
    * `type` - тип операционной системы (Windows, Linux, MacOS). Пустая строка, если проверка не выполнялась;
    * `version` - редакция и версия операционной системы. Пустая строка, если проверка не выполнялась;
    * `domain` - имя домена. Пустая строка, если проверка не выполнялась или отсутствует домен.
  * `kb_list` - список наименований установленных пакетов обновлений (KB) для Windows.
  * `antivirus` - список результатов проверок Антивирусов по числу установленных антивирусных пакетов:
    * `active` - статус антивируса: 
      * `true` - запущен;
      * `false` - не запущен.
    * `name` - название антивируса. Пустая строка, если проверка не выполнялась;
    * `version` - версия антивируса. Пустая строка, если проверка не выполнялась;
    * `last_update` - количество полных дней, прошедших с последнего обновления баз. Пустая строка, если проверка не выполнялась;
    * `last_scan` - количество полных дней, прошедших с последнего сканирования. Пустая строка, если проверка не выполнялась; 
  * `firewall` - список результатов проверок межсетевых экранов:
    * `active` - статус межсетевого экрана:
      * `true` - запущен;
      * `false`- не запущен.
    * `name` - наименование межсетевого экрана. Пустая строка, если проверка не выполнялась; 
    * `version` - версия межсетевого экрана. Пустая строка, если проверка не выполнялась;
  * `proc_list` - список найденных процессов;
  * `service_list` - список найденных служб Windows;
  * `reg_key_list` - список найденных ключей реестра:
    * `key` - путь и имя ключа реестра;
    * `value` - значение параметра.
* `hip_profiles` - список наименований профилей, которым соответствует устройство;
* `hip_objects` - соответствие настроенным HIP-объектам:
  * `hip_object` - наименование HIP-объекта;
  * `is_match` - соответствует ли устройство требованиям HIP-объекта:
    * `true` - соответствует;
    * `false` - не соответствует.

{% endcut %}
