# Аудит-логирование

Все API-запросы должны быть аутентифицированы, как описано в разделе Начало работы.

Используйте этот эндпоинт для получения журналов аудита, которые позволят вам отслеживать и предупреждать подозрительную активность сотрудников.

GET /resources/auditTrailEvents

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

Название	Тип	Обязательно	Описание
`subjectName`	String	Нет	Имя учетной записи, для которого будут получены события. Если имя не указано, события будут получены для всех.
`activity`	String	Нет	Если указано, в ответе будут присутствовать только этот тип событий.
`from`	String	Нет	С какого времени принимаются события (формат `yyyy-MM-dd HH:mm:ss`). Если дата не указана, будут приниматься события со вчерашнего дня.
`to`	String	Нет	До какого времени принимаются события (формат `yyyy-MM-dd HH:mm:ss`). Если дата не указана, будут приниматься события до настоящего времени.
`limit`	Integer	Нет	Максимальное количество событий в одном ответе. Не может быть больше `20000`, по умолчанию равно `10`.
`offset`	Integer	Нет	Позволяет пропустить указанное количество событий из возвращаемого списка. По умолчанию — `0`.

Ответ

Статус HTTP 200 в ответе подтверждает доступность нашего API. Тело ответа содержит полезную нагрузку в формате JSON со списком событий.

События всегда отсортированы по полю ts в порядке убывания (от новых к старым). Максимальное количество событий в одном запросе — 20 000.

Пример

      Запрос
    
      Ответ
    
Copy
curl -X GET \
  'https://api.cyberity.ru/resources/auditTrailEvents'
{
  "items": [
    {
      "ts": "2022-10-06 08:23:28.715",
      "clientId": "sample_key",
      "activity": "subject:loggedIn:dashboard:success",
      "subjectName": "subject@name.com",
      "ip": "5.64.19.63",
      "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML,like Gecko) Chrome/106.0.0.0 Safari/537.36 Edg/106.0.1370.34",
      "xClientId": "dashboard",
      "correlationId": "req-7ae0a875-1d06-1234-b266-8fe2a24f22fa",
      "applicantId": "",
      "externalUserId": "",
      "imageId": "",
      "description": ""
    },
    {
      "ts": "2022-10-05 06:37:58.858",
      "clientId": "sample_key",
      "activity": "subject:loaded:applicantList",
      "subjectName": "subject@name.com",
      "ip": "46.109.67.83",
      "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML,like Gecko) Chrome/105.0.0.0 Safari/537.36",
      "xClientId": "dashboard",
      "correlationId": "req-afea91b7-21e7-1234-98fb-ebe4d2867df6",
      "applicantId": "",
      "externalUserId": "",
      "imageId": "",
      "description": "cnt=10"
    }
  ],
  "totalItems": 2
}

Поля событий

Название	Тип	Обязательно	Описание
`ts`	String	Да	Дата/время события.
`clientId`	String	Да	Уникальный идентификатор вас как нашего клиента.
`activity`	String	Да	Тип события.
`subjectName`	String	Да	Имя учетной записи, для которого будут получены события.
`ip`	String	Да	IP-адрес, с которого было зафиксировано событие.
`userAgent`	String	Нет	Устройство, с которого было зафиксировано событие.
`xClientId`	String	Нет	Источник события: API / дешборд / SDK.
`correlationId`	String	Да	Идентификатор, который однозначно идентифицирует событие на нашей стороне.
`applicantId`	String	Нет	Идентификатор пользователя.
`externalUserId`	String	Нет	Внешний идентификатор пользователя – уникальный идентификатор пользователя на вашей стороне.
`imageId`	String	Нет	Идентификатор изображения.
`description`	String	Нет	Дополнительная информация.

Типы событий:

Название	Описание
`subject:loggedIn:dashboard:success`	Успешный вход в систему.
`subject:loggedIn:dashboard:failure`	Ошибка при входе в систему.
`subject:loggedOut:dashboard`	Выход из системы.
`subject:loaded:applicant`	Загрузка информации о пользователе.
`subject:loaded:applicantList`	Загрузка списка пользователей.
`subject:exported:applicantCsvList`	Загрузка списка пользователей в формате `.CVS`.
`subject:downloaded:docImage`	Скачивание документа пользователя.
`subject:changed:applicant`	Изменение данных заявителя.