1 API Manual de utilizare a ESET SECURE SECURITY
dacă ($ this-> show_pages_images $ page_num doc ['images_node_id'])
8 Câmpul last_success este data care indică data ultimei autentificări a utilizatorului. Acest câmp poate fi nul. Câmpul last_failure este data ultimei autentificări a utilizatorului care a eșuat. Acest câmp poate fi nul. Câmpul consecutiv_failuri este un întreg care indică numărul de încercări succesive de autentificare pe care le-a efectuat utilizatorul și care au eșuat. Câmpul credential_type este un tablou care indică tipurile de OTP incluse pentru utilizator. O matrice poate conține următoarele tipuri de OTP: APP, utilizatorului i se permite accesul la aplicația ESA mobilă. SMS-ul pentru utilizator este configurat pentru a trimite OTP-uri prin SMS. HARD_TOKEN pentru utilizator este configurat pentru a trimite OTP-uri create de jetoanele hardware. 5.2 Deblocare Această metodă este folosită pentru a debloca 2FA pentru utilizator. Deblocați contul, blocate de Active Directory, aceasta nu cere pentru a debloca utilizatorul, trimite o cerere HTTP POST la următorul URI: / gestiona / utilizatorii / v1 / deblocare „username“: „USERNAME“ nume de utilizator câmp este un șir de caractere cu utilizatorul sAMAccountName tine trebuie să deblocați. Asigurați-vă că numele de utilizator corect este trimis către API: samaccountname este numele de utilizator pentru conectarea la serviciul Răspundeți la Active Directory ((OK) HTTP). Răspunsul este șirul JSON. Răspunsul conține numai codul de eroare posibil și mesajul. Mai jos este un exemplu de răspuns standard. 8
9 5.3 Revizuirea Această metodă dezactivează 2FA Solicitare utilizator Pentru a dezactiva 2FA pentru utilizator, trimite o cerere HTTP POST la următorul URI: / gestiona / utilizatorii / v1 / deprovision „username“: „USERNAME“ nume de utilizator câmp este un șir de caractere cu utilizatorul sAMAccountName pentru care doriți dezactivați 2FA. Aveți grijă ca în API-ul a trimis un nume de utilizator valid: sAMAccountName acest nume de utilizator pentru a vă conecta la Active Directory A ((OK) HTTP). Răspunsul este șirul JSON. Răspunsul conține numai codul de eroare posibil și mesajul. Mai jos este un exemplu de răspuns standard. 5.4 Pregătirea unei aplicații mobile Această metodă permite utilizatorilor să utilizeze OTP pentru aplicații mobile. Utilizatorul va fi trimis un mesaj de tip text, cu adresa URL pentru instalări de aplicații mobile Cerere Pentru a pregăti utilizatorul de a utiliza Mobile Application, trimite o cerere HTTP POST la următorul URI: / gestiona / utilizatorii / v1 / provisionmobileapp „username“: „USERNAME“ nume de utilizator câmp este un șir de caractere cu utilizatorul sAMAccountName , care trebuie pregătite. Țineți evidența celor 9
11 6. Manipularea erorilor 6.1 Erori API Toate erorile API vor fi returnate ca răspunsuri cu un cod de stare HTTP 200 (OK). Câmpul de eroare din răspunsul JSON va conține codul de eroare, care este valoarea șirului literal. Sunt definite următoarele coduri de eroare: ERROR_NONE: fără erori; ERROR_USER_NOT_FOUND: Numele de utilizator specificat nu există în sistem; ERROR_FAULT: A apărut o eroare necunoscută. În plus față de câmpul de eroare, există și un câmp error_message, care specifică o descriere clară a erorii. Pentru a determina condițiile de eroare, utilizați numai câmpul de eroare, deoarece câmpul error_message servește numai scopuri informaționale și poate fi modificat fără o notificare prealabilă. 6.2 Erori HTTP Toate erorile HTTP vor fi returnate ca răspunsuri fără text sau răspunsuri cu orice alt cod de stare HTTP altul decât 200 (OK). Următoarele coduri de stare HTTP eronate pot fi returnate: HTTP 500 (Internal Server Error): a apărut o eroare nerecuperabilă necunoscută în serviciul API. HTTP 400 (cerere incorectă): Formatul antetului "Autorizare" nevalid în solicitarea HTTP. HTTP 401 (neautorizat): solicitarea HTTP nu include acreditările API. HTTP 403 (interzis): Solicitarea HTTP conține acreditări incorecte. 11