API запросов доступа

API для создания запросов доступа на двухфакторную аутентификацию, а также для получения истории запросов.

Создание запроса доступа

Функция для создания запроса на двухфакторную аутентификацию.

Доступ к API

Для создания запросов доступа необходима авторизация с API Key и API Secret ресурса, к которому создается запрос доступа. Оба значения доступны в личном кабинете, в разделе "Ресурсы" -> "Параметры".

Адрес https://api.multifactor.ru/access/requests | метод POST.

Пример запроса:

{
    "identity": "user@example.com",     //логин пользователя
    "email":    "user@example.com",     //e-mail, необязательно
    "phone":    null,                   //телефон, необязательно
    "language": null,                   //язык: ru/en, по умолчанию ru
    "claims":                           //произвольный набор параметров 
    {
        "param1": "value1",
        "param2": "value2",
    },
    "callback":                         //адрес возврата пользователя
    {
        "action": "https://example.com/mf/callback",
        "target": "_self"
    }
}

Параметр	Назначение	Формат
identity	Уникальный идентификатор пользователя в вашей системе	Любой
claims	Произвольный набор параметров для включения в JWT	json
callback.action	Адрес на вашем сайте для возврата пользователя после успешной аутентификации	Url
callback.target	Для размещения страницы доступа в iframe	_self, _parent, _top

Пример ответа:

{
    "model": 
    {
        "id":"620UNJe",                                 //id запроса
        "url":"https://access.multifactor.ru/620UNJe"   //адрес станицы доступа
    },
    "success":true,
    "message":null
}

История запросов доступа

Функция для получения истории запросов доступа пользователей.

Доступ к API

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

Адрес https://api.multifactor.ru/access/requests | метод GET.

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

• [обязательный] createdAt — дата, не может быть сегодняшней (пример: 2021-09-25);
• identity — фильтр по логину (пример: user);
• offset — сдвиг окна (пример: 250);
• limit — ширина окна (пример: 250, максимум: 1000).

Пример запроса:

GET https://api.multifactor.ru/access/requests?createdAt=2023-02-02

Еще пример:

GET https://api.multifactor.ru/access/requests?createdAt=2023-02-02&identity=user&offset=0&limit=1

Пример ответа:

{
    "model": 
    {
        "data": 
        [
            {
                "id": "MuNG3Ed",                                //id
                "identity": "user",                             //логин (субъект доступа)
                "status": "Granted",                            //статус запроса
                "resourceName": "Cisco ASA",                    //ресурс (объект доступа)
                "createdAt": "2023-02-02T20:48:52.4010000Z",    //время создания запроса
                "grantedAt": "2023-02-02T20:48:56.8400000Z",    //время подтверждения запроса
                "authenticator": "Telegram",                    //аутентификатор
                "countryCode": "RU",                            //гео: код страны
                "region": "Красноярский край",                  //гео: регион
                "city": "Красноярск",                           //гео: город
                "remoteHost": "10.10.10.10",                    //ip пользователя или имя хоста
                "ip" : "10.10.10.10",                           //ip пользователя
                "twoFADeviceIp": "192.168.1.1"                  //ip устройства, с которого был подтвержден второй фактор (кроме Telegram)
            }
        ],
        "offset": 0,
        "limit": 1,
        "totalElements": 1
    },
    "success": true,
    "message": null
}