user.login

Apraksts

string/object user.login(object parameters)

Šī metode ļauj pieteikties API un ģenerēt autentifikācijas marķieri.

Izmantojot šo metodi, jums ir jāizsauc arī user.logout, lai novērstu liela skaita atvērtu sesiju ierakstu ģenerēšanu.

Šī metode ir pieejama tikai neautentificētiem lietotājiem, kuri nepieder nevienai lietotāju grupai, kurai ir iespējota daudzfaktoru autentifikācija.

Parametri

(object) Parametri, kas satur lietotāja vārdu un paroli.

Metode pieņem šādus parametrus.

Parametrs Tips Apraksts
password string Lietotāja parole.

Parametra darbība:
- obligāts
username string Lietotāja vārds.

Parametra darbība:
- obligāts
userData flag Atgriezt informāciju par autentificēto lietotāju.

Atgrieztās vērtības

(string/object) Ja tiek izmantots parametrs userData, tiek atgriezts objekts, kas satur informāciju par autentificēto lietotāju.

Papildus standarta lietotāja īpašībām tiek atgriezta šāda informācija:

Īpašība Tips Apraksts
auth_type integer Noklusējuma autentifikācija lietotājam.

Iespējamo vērtību sarakstu skatiet Authentication object īpašībā authentication_type.
debug_mode integer Vai lietotājam ir iespējots vai atspējots atkļūdošanas režīms.

Iespējamo vērtību sarakstu skatiet User group object īpašībā debug_mode.
deprovisioned boolean Vai lietotājs pieder deprovisioned users group.
gui_access string Lietotāja autentifikācijas metode lietotāja saskarnei.

Iespējamo vērtību sarakstu skatiet User group object īpašībā gui_access.
mfaid integer MFA method ID, kas jāizmanto lietotājam pieteikšanās laikā.

Atgriež "0", ja MFA ir globāli atspējota vai atspējota visām lietotāju grupām, kurām lietotājs pieder.
secret string Nejauša 32 rakstzīmju virkne. Tiek ģenerēta lietotāja pieteikšanās laikā.
sessionid string Autentifikācijas marķieris, kas jāizmanto turpmākajos API pieprasījumos.
type integer Lietotāja tips.

Iespējamo vērtību sarakstu skatiet Role object īpašībā type.
userip string Lietotāja IP adrese.

Ja lietotājs ir veiksmīgi autentificēts pēc viena vai vairākiem neveiksmīgiem mēģinājumiem, metode atgriezīs pašreizējās vērtības īpašībām attempt_clock, attempt_failed un attempt_ip, un pēc tam tās atiestatīs.

Ja parametrs userData netiek izmantots, metode atgriež autentifikācijas marķieri, kas ir nepieciešams autentifikācijai.

Piemēri

Lietotāja autentificēšana

Autentificējiet lietotāju.

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "user.login",
    "params": {
        "username": "Admin",
        "password": "zabbix"
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": "0424bd59b807674191e7d77572075f33",
    "id": 1
}

Autentificētā lietotāja informācijas pieprasīšana

Autentificējiet un atgrieziet papildu informāciju par lietotāju.

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "user.login",
    "params": {
        "username": "Admin",
        "password": "zabbix",
        "userData": true
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": {
        "userid": "1",
        "username": "Admin",
        "name": "Zabbix",
        "surname": "Administrator",
        "url": "",
        "autologin": "1",
        "autologout": "0",
        "lang": "ru_RU",
        "refresh": "0",
        "theme": "default",
        "attempt_failed": "0",
        "attempt_ip": "127.0.0.1",
        "attempt_clock": "1355919038",
        "rows_per_page": "50",
        "timezone": "Europe/Riga",
        "roleid": "3",
        "userdirectoryid": "0",
        "type": 3,
        "userip": "127.0.0.1",
        "debug_mode": 0,
        "gui_access": "0",
        "mfaid": "1",
        "deprovisioned": false,
        "auth_type": 0,
        "sessionid": "5b56eee8be445e98f0bd42b435736e42",
        "secret": "cd0ba923319741c6586f3d866423a8f4"
    },
    "id": 1
}

Skatīt arī

Avots

CUser::login() failā ui/include/classes/api/services/CUser.php.