Documentation
Table of Contents
כניסת משתמש
תיאור
string/object user.login(אובייקט פרמטרים)
שיטה זו מאפשרת להיכנס ל-API וליצור אימות אֲסִימוֹן.
::: הערה אזהרה בעת שימוש בשיטה זו, אתה גם צריך לעשות user.logout כדי למנוע את יצירת מספר רב של רשומות הפעלה פתוחות. :::
::: שימו לב חשוב שיטה זו זמינה רק לבלתי מאומתים משתמשים ויש לקרוא אותם ללא פרמטר auth ב-JSON-RPC בַּקָשָׁה. :::
פרמטרים
(object) פרמטרים המכילים את שם המשתמש והסיסמה.
השיטה מקבלת את הפרמטרים הבאים.
| פרמטר | סוג | תיאור |
|---|---|---|
| סיסמה (נדרש) |
מחרוזת | סיסמת משתמש. |
| שם משתמש (חובה) |
מחרוזת | שם משתמש. |
| userData | flag | החזר מידע על המשתמש המאומת. |
| user (deprecated) |
string | פרמטר זה הוצא משימוש, אנא השתמש ב-'username' במקום זאת. שם משתמש. |
החזר ערכים
(string/object) אם נעשה שימוש בפרמטר userData, מחזיר אובייקט המכיל מידע על המשתמש המאומת.
בנוסף ל-מאפייני משתמש סטנדרטיים, ה- המידע הבא מוחזר:
| Property | Type | תיאור |
|---|---|---|
| debug_mode | boolean | האם מצב ניפוי באגים מופעל עבור המשתמש. |
| gui_access | integer | שיטת האימות של המשתמש ל-frontend. עיין במאפיין gui_access של אובייקט קבוצת המשתמש עבור רשימת ערכים אפשריים. |
| sessionid | string | אסימון אימות, שבו יש להשתמש בבקשות ה-API הבאות. |
| userip | string | כתובת ה-IP של המשתמש. |
אם משתמש אושר בהצלחה לאחר אחד או יותר ניסיונות כושלים, השיטה תחזיר את הערכים הנוכחיים עבור המאפיינים ttempt_clock, ttempt_failed ו-attempt_ip ו ואז אפס אותם.
אם לא נעשה שימוש בפרמטר userData, השיטה מחזירה an אסימון אימות.
יש לזכור את אסימון האימות שנוצר ובשימוש בפרמטר auth של בקשות ה-JSON-RPC הבאות. זה נדרש גם בעת שימוש באימות HTTP.
דוגמאות
אימות משתמש
אימות משתמש.
בַּקָשָׁה:
{
"jsonrpc": "2.0",
"method": "user.login",
"params": {
"username": "מנהל",
"סיסמה": "zabbix"
},
"מזהה": 1
}תְגוּבָה:
מבקש מידע מאומת של משתמש
אימות והחזר מידע נוסף על המשתמש.
בַּקָשָׁה:
{
"jsonrpc": "2.0",
"method": "user.login",
"params": {
"username": "מנהל",
"סיסמה": "zabbix",
"userData": נכון
},
"מזהה": 1
}תְגוּבָה:
{
"jsonrpc": "2.0",
"תוצאה": {
"userid": "1",
"username": "מנהל",
"name": "Zabix",
"surname": "מנהל",
"url": "",
"autologin": "1",
"autologout": "0",
"lang": "ru_RU",
"refresh": "0",
"theme": "ברירת מחדל",
"attempt_failed": "0",
"attempt_ip": "127.0.0.1",
"attempt_clock": "1355919038",
"rows_per_page": "50",
"timezone": "אירופה/ריגה",
"roleid": "3",
"סוג": 3,
"debug_mode": 0,
"userip": "127.0.0.1",
"gui_access": "0",
"sessionid": "5b56eee8be445e98f0bd42b435736e42"
},
"מזהה": 1
}מידע נוסף
מקור
CUser::login() בתוך ui/include/classes/api/services/CUser.php.