Documentation
Table of Contents
user.login
³¢±ð¨ª°ù¨¢²õ
string/object user.login(objektumparam¨¦terek)
Ez a m¨®dszer lehet?v¨¦ teszi az API-ba val¨® bejelentkez¨¦²õt ¨¦²õ hiteles¨ªt¨¦²õ l¨¦trehoz¨¢s¨¢t jelk¨¦pes.
Ha ezt a m¨®dszert haszn¨¢lja, akkor is meg kell tennie user.logout a nagysz¨¢m¨² nyitott munkamenet rekord gener¨¢l¨¢sa.
Ez a m¨®dszer csak nem hiteles¨ªtett felhaszn¨¢l¨®k sz¨¢m¨¢ra ¨¦rhet? el felhaszn¨¢l¨®kat, ¨¦²õ a JSON-RPC auth param¨¦tere n¨¦lk¨¹l kell megh¨ªvni k¨¦r¨¦²õ.
±Ê²¹°ù²¹³¾¨¦³Ù±ð°ù±ð°ì
(object) A felhaszn¨¢l¨®nevet ¨¦²õ Âá±ð±ô²õ³ú¨®t tartalmaz¨® param¨¦terek.
A m¨®dszer a k?vetkez? param¨¦tereket fogadja el.
| ±Ê²¹°ù²¹³¾¨¦³Ù±ð°ù | °Õ¨ª±è³Ü²õ | ³¢±ð¨ª°ù¨¢²õ |
|---|---|---|
| Âá±ð±ô²õ³ú¨® (k?telez?) |
string | Felhaszn¨¢l¨®i Âá±ð±ô²õ³ú¨®. |
| ´Ú±ð±ô³ó²¹²õ³ú²Ô¨¢±ô¨®²Ô¨¦±¹ (k?telez?) |
°ì²¹°ù²¹°ì³Ù±ð°ù±ô¨¢²Ô³¦ | ¹ó±ð±ô³ó²¹²õ³ú²Ô¨¢±ô¨®²Ô¨¦±¹. |
| userData | flag | A hiteles¨ªtett felhaszn¨¢l¨® adatait adja vissza. |
Visszat¨¦r¨¦²õi ¨¦rt¨¦kek
(°ì²¹°ù²¹°ì³Ù±ð°ù±ô¨¢²Ô³¦/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:
| °Õ³Ü±ô²¹Âá»å´Ç²Ô²õ¨¢²µ | °Õ¨ª±è³Ü²õ | ³¢±ð¨ª°ù¨¢²õ |
|---|---|---|
| debug_mode | boolean | Enged¨¦lyezett-e a hibakeres¨¦²õi m¨®d a felhaszn¨¢l¨® sz¨¢m¨¢ra. |
| gui_access | integer | Felhaszn¨¢l¨® hiteles¨ªt¨¦²õi 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 | ±á¾±³Ù±ð±ô±ð²õ¨ª³Ù¨¦²õi token, amelyet a k?vetkez? API-k¨¦r¨¦²õekben kell haszn¨¢lni. |
| userip | string | A felhaszn¨¢l¨® IP-c¨ªme. |
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 ¨¦²õ attempt_ip tulajdons¨¢gok ¨¦²õ majd ¨¢ll¨ªtsa vissza ?ket.
Ha a userData param¨¦ter nincs haszn¨¢latban, a met¨®dus egy an hiteles¨ªt¨¦²õi token.
A gener¨¢lt hiteles¨ªt¨¦²õi tokent meg kell jegyezni ¨¦²õ a k?vetkez? JSON-RPC k¨¦r¨¦²õek "auth" param¨¦ter¨¦ben haszn¨¢lj¨¢k. Azt HTTP hiteles¨ªt¨¦²õ haszn¨¢latakor is sz¨¹ks¨¦ges.
±Ê¨¦±ô»å¨¢°ì
Authenticating a user
Authenticate a user.
Request:
{
"jsonrpc": "2.0",
"method": "user.login",
"params": {
"username": "Admin",
"password": "zabbix"
},
"id": 1
}Response:
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": "Áú»¢¶Ä²©",
"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
¹ó´Ç°ù°ù¨¢²õ
CUser::login() az ui/include/classes/api/services/CUser.php-ban.