user.login

Leírás

string/object user.login(objektumparaméterek)

Ez a módszer lehetővé teszi az API-ba való bejelentkezést és hitelesítés létrehozását jelképes.

::: megjegyzésfigyelmeztetés Ha ezt a módszert használja, akkor is meg kell tennie user.logout a nagyszámú nyitott munkamenet rekord generálása. :::

::: Fontos Ez a módszer csak nem hitelesített felhasználók számára érhető el felhasználókat, és a JSON-RPC auth paramétere nélkül kell meghívni kérés. :::

Paraméterek

(object) A felhasználónevet és jelszót tartalmazó paraméterek.

A módszer a következő paramétereket fogadja el.

Paraméter Típus Leírás
jelszó
(kötelező)		 string Felhasználói jelszó.
felhasználónév
(kötelező)		 karakterlánc Felhasználónév.
userData flag A hitelesített felhasználó adatait adja vissza.

Visszatérési értékek

(karakterlánc/objektum) Ha a userData paramétert használja, egy objektumot ad vissza információkat tartalmaz a hitelesített felhasználóról.

A standard felhasználói tulajdonságok mellett a a következő információkat küldjük vissza:

Tulajdonság Típus Leírás
debug_mode boolean Engedélyezett-e a hibakeresési mód a felhasználó számára.
gui_access integer Felhasználó hitelesítési módszere a kezelőfelülethez.

Tekintse meg a user group object gui_access tulajdonságát egy lehetséges értékek listája.
sessionid string Hitelesítési token, amelyet a következő API-kérésekben kell használni.
userip string A felhasználó IP-címe.

::: jegyzet Ha egy felhasználót egy után sikeresen hitelesítettek vagy több sikertelen kísérlet esetén a metódus az aktuális értékeket adja vissza a attempt_clock, attempt_failed és attempt_ip tulajdonságok és majd állítsa vissza őket. :::

Ha a userData paraméter nincs használatban, a metódus egy an hitelesítési token.

::: jegyzet A generált hitelesítési tokent meg kell jegyezni és a következő JSON-RPC kérések "auth" paraméterében használják. Azt HTTP hitelesítés használatakor is szükséges. :::

Példák

Authenticating a user

Authenticate a user.

Request:

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

Response:

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

Requesting authenticated user's information

Authenticate and return additional information about the user.

Request:

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

Response:

{
    "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",
        "type": 3,
        "debug_mode": 0,
        "userip": "127.0.0.1",
        "gui_access": "0",
        "sessionid": "5b56eee8be445e98f0bd42b435736e42"
    },
    "id": 1
}

Lásd még

Forrás

CUser::login() az ui/include/classes/api/services/CUser.php-ban.