1 ESET SECURE AUTHENTICATION Керівництво користувача API
if ($ this-> show_pages_images $ Page_num doc [ 'images_node_id'])
8 Поле last_success це Date, яка вказує, коли в останній раз користувач успішно пройшов аутентифікацію. Це поле може мати значення null. Поле last_failure це Date останньої аутентифікації користувача, яка завершилася збоєм. Це поле може мати значення null. Поле consecutive_failures це Integer, що позначає кількість послідовних спроб аутентифікації, які виконував користувач і які закінчилися збоєм. Поле credential_type це масив, який позначає типи OTP, включені для користувача. Масив може містити наступні типи OTP: APP користувачеві відкритий доступ до мобільного додатку ESA. SMS для користувача налаштована відправка OTPs через SMS. HARD_TOKEN для користувача налаштована відправка OTPs, створених маркерами обладнання. 5.2 Розблокування Цей метод використовується для розблокування 2FA для користувача. Розблокувати обліковий запис, заблоковану службою Active Directory, з його допомогою можна Запит Щоб розблокувати користувача, надішліть запит HTTP POST на наступний URI: / manage / users / v1 / unlock "username": "USERNAME" Поле username це рядок з samaccountname користувача, якого потрібно розблокувати. Слідкуйте за тим, щоб в API було відправлено правильне ім'я користувача: samaccountname це ім'я користувача для входу в Active Directory Відповідь ((OK) HTTP). Відповіддю є рядок JSON. Відповідь містить тільки код можливої помилки і повідомлення. Нижче наведено приклад стандартної відповіді. 8
9 5.3 Відкликання Цей метод відключає 2FA для користувача Запит Щоб відключити 2FA для користувача, надішліть запит HTTP POST на наступний URI: / manage / users / v1 / deprovision "username": "USERNAME" Поле username це рядок з samaccountname користувача, для якого потрібно відключити 2FA. Слідкуйте за тим, щоб в API було відправлено правильне ім'я користувача: samaccountname це ім'я користувача для входу в Active Directory Відповідь ((OK) HTTP). Відповіддю є рядок JSON. Відповідь містить тільки код можливої помилки і повідомлення. Нижче наведено приклад стандартної відповіді. 5.4 Підготовка мобільного застосування Цей метод дозволяє користувачам використовувати Mobile Application OTPs. Користувачеві буде відправлено текстове повідомлення з URL для установки мобільного додатка Запит Щоб підготувати користувача до використання Mobile Application, надішліть запит HTTP POST на наступний URI: / manage / users / v1 / provisionmobileapp "username": "USERNAME" Поле username це рядок з samaccountname користувача , якого потрібно підготувати. Слідкуйте за тим, 9
11 6. Обробка помилок 6.1 Помилки API Всі помилки API будуть повернуті як відповіді з кодом стану HTTP 200 (OK). Поле error у відповіді JSON буде містити код помилки, який є значенням рядка литерала. Визначено наступні коди помилок: ERROR_NONE: помилок немає; ERROR_USER_NOT_FOUND: вказане ім'я користувача не існує в системі; ERROR_FAULT: сталася невідома помилка. Крім поля error, також є поле error_message, в якому вказується зрозумілий опис помилки. Для визначення умов помилки слід використовувати тільки поле error, так як поле error_message служить тільки інформаційним цілям і може бути змінено без попереднього повідомлення. 6.2 Помилки HTTP Всі помилки HTTP будуть повертатися як відповіді без тексту або відповіді з будь-яким кодом стану HTTP, крім 200 (OK). Можуть бути повернені наступні помилкові коди стану HTTP: HTTP 500 (Internal Server Error): в службі API сталася невідома невиправна помилка. HTTP 400 (Bad Request): неправильний формат заголовка "Authorization" в запиті HTTP. HTTP 401 (Unauthorized): в запиті HTTP не вказані облікові дані API. HTTP 403 (Forbidden): в запиті HTTP вказані неправильні облікові дані. 11