API Журнала

API для получения событий из журнала по различным параметрам.

Доступ к API

Перед использованием данного API необходимо включить расширенное API в личном кабинете, в разделе "Настройки API" и использовать API Key и API Secret, предоставленные в разделе.

URL для запроса

Функция для запроса всех действий журнала. Адрес https://api.multifactor.ru/journal | метод GET.

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

Параметры окна

Константы

Примеры запросов

Запрос всех событий на определённую дату:

GET https://api.multifactor.ru/journal?eventdate=2024-07-10

Запрос событий с определённым действием:

GET https://api.multifactor.ru/journal?eventdate=2024-07-10&action=Create

Запрос событий с несколькими действиями:

GET https://api.multifactor.ru/journal?eventdate=2024-07-10&action=Create&action=Delete

Запрос событий с указанием субъекта:

GET https://api.multifactor.ru/journal?eventdate=2024-07-10&subject=apashkov&action=Create&action=Delete

Запрос событий с указанием субъекта и объекта:

GET https://api.multifactor.ru/journal?eventdate=2024-07-10&subject=apashkov&action=Create&action=Delete&object=User&object=Resource

Примеры ответов

Ниже приведён форматированный пример ответа API, который содержит данные о действиях пользователя с электронной почтой user@example.com за дату 2024-07-04. Данный ответ включает в себя события авторизации и отправки ссылки на регистрацию, выполненные администратором.

{
    "model": {
        "data": [
            {
                "eventId": "TCHYmXlrvhb",                          //уникальный идентификатор события
                "eventDate": "2024-07-04T08:56:06.933Z",          //дата и время события в формате ISO 8601.
                "object": "AdminPanel",                          //объект, к которому относится событие (например, AdminPanel, EnrollmentLink, User).
                "subject": "user@example.com",                   //электронная почта пользователя, связанного с событием
                "action": "SignIn",                             //действие, выполненное пользователем (например, SignIn, Send, Create).
                "success": true,                               //указывает на успешность выполнения действия (true или false).
                "additionalFields": {                         //дополнительные поля, содержащие подробности о событии
                    "2FAMethod": "Telegram",                 //метод двухфакторной аутентификации (например, Telegram).
                    "UserIp": "8.8.8.8"                     //ip-адрес пользователя
                }
            },
            {
                "eventId": "Bd000BCeV2z",                                                               //уникальный идентификатор события
                "eventDate": "2024-07-04T08:10:01.298Z",                                               //дата и время события в формате ISO 8601
                "object": "EnrollmentLink",                                                           //объект, к которому относится событие (например, AdminPanel, EnrollmentLink, User).      
                "subject": " user@example.com ",                                                     //электронная почта пользователя, связанного с событием
                "action": "Send",                                                                  //действие, выполненное пользователем (например, SignIn, Send, Create).
                "success": true,                                                                  //указывает на успешность выполнения действия (true или false).
                "additionalFields": {                                                           //дополнительные поля, содержащие подробности о событии
                    "UserIdentity": "test123445",                                             //идентификатор пользователя.
                    "EnrollmentLink": "https://access.multifactor.ru/wizard/OVqrR4HTv",      //ссылка на регистрацию.
                    "EnrollmentLinkEmail": " user@example.com ",                            //электронная почта, на которую была отправлена ссылка на регистрацию      
                    "EnrollmentLinkTTL": "25"                                              //время жизни ссылки на регистрацию. 
}

Эти примеры иллюстрируют, как можно использовать API для получения различных событий из журнала, используя разнообразные параметры и фильтры.