[comment]: # translation:outdated

[comment]: # ({19701d17-19701d17})
# כניסת משתמש

[comment]: # ({/19701d17-19701d17})

[comment]: # ({c647dda4-c647dda4})
### תיאור

`string/object user.login(אובייקט פרמטרים)`

שיטה זו מאפשרת להיכנס ל-API וליצור אימות
אֲסִימוֹן.

::: הערה אזהרה
בעת שימוש בשיטה זו, אתה גם צריך לעשות
[user.logout](/manual/api/reference/user/logout) כדי למנוע את
יצירת מספר רב של רשומות הפעלה פתוחות.
:::

::: שימו לב חשוב
שיטה זו זמינה רק לבלתי מאומתים
משתמשים ויש לקרוא אותם ללא פרמטר `auth` ב-JSON-RPC
בַּקָשָׁה.
:::

[comment]: # ({/c647dda4-c647dda4})

[comment]: # ({0d823de3-68f0a066})
### פרמטרים

`(object)` פרמטרים המכילים את שם המשתמש והסיסמה.

השיטה מקבלת את הפרמטרים הבאים.

|פרמטר|[סוג](/manual/api/reference_commentary#data_types)|תיאור|
|--|--|------|
|**סיסמה**<br>(נדרש)|מחרוזת|סיסמת משתמש.|
|**שם משתמש**<br>(חובה)|מחרוזת|שם משתמש.|
|userData|flag|החזר מידע על המשתמש המאומת.|
|user<br>(deprecated)|string|פרמטר זה הוצא משימוש, אנא השתמש ב-'username' במקום זאת.<br>שם משתמש.|

[comment]: # ({/0d823de3-68f0a066})

[comment]: # ({0c2cbc1a-bc924c62})
### החזר ערכים

`(string/object)` אם נעשה שימוש בפרמטר `userData`, מחזיר אובייקט
המכיל מידע על המשתמש המאומת.

בנוסף ל-[מאפייני משתמש סטנדרטיים](object#user), ה-
המידע הבא מוחזר:

|Property|[Type](/manual/api/reference_commentary#data_types)|תיאור|
|--|--|------|
|debug\_mode|boolean|האם מצב ניפוי באגים מופעל עבור המשתמש.|
|gui\_access|integer|שיטת האימות של המשתמש ל-frontend.<br><br>עיין במאפיין `gui_access` של [אובייקט קבוצת המשתמש](/manual/api/reference/usergroup/object#user_group) עבור רשימת ערכים אפשריים.|
|sessionid|string|אסימון אימות, שבו יש להשתמש בבקשות ה-API הבאות.|
|userip|string|כתובת ה-IP של המשתמש.|

::: הערה
אם משתמש אושר בהצלחה לאחר אחד
או יותר ניסיונות כושלים, השיטה תחזיר את הערכים הנוכחיים עבור
המאפיינים `ttempt_clock`, `ttempt_failed` ו-`attempt_ip` ו
ואז אפס אותם.
:::

אם לא נעשה שימוש בפרמטר `userData`, השיטה מחזירה an
אסימון אימות.

::: הערה
יש לזכור את אסימון האימות שנוצר
ובשימוש בפרמטר `auth` של בקשות ה-JSON-RPC הבאות. זה
נדרש גם בעת שימוש באימות HTTP.
:::

[comment]: # ({/0c2cbc1a-bc924c62})

[comment]: # ({b41637d2-b41637d2})
### דוגמאות

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({a85bb18c-46abbe5a})
#### אימות משתמש

אימות משתמש.

בַּקָשָׁה:

``` json
{
     "jsonrpc": "2.0",
     "method": "user.login",
     "params": {
         "username": "מנהל",
         "סיסמה": "zabbix"
     },
     "מזהה": 1
}
```

תְגוּבָה:

``` json
{
     "jsonrpc": "2.0",
     "result": "0424bd59b807674191e7d77572075f33",
     "מזהה": 1
}
```

[comment]: # ({/a85bb18c-46abbe5a})

[comment]: # ({bca1bf53-8448c8ab})
#### מבקש מידע מאומת של משתמש

אימות והחזר מידע נוסף על המשתמש.

בַּקָשָׁה:

``` json
{
     "jsonrpc": "2.0",
     "method": "user.login",
     "params": {
         "username": "מנהל",
         "סיסמה": "zabbix",
         "userData": נכון
     },
     "מזהה": 1
}
```

תְגוּבָה:

``` json
{
     "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
}
```

[comment]: # ({/bca1bf53-8448c8ab})

[comment]: # ({22a14fca-22a14fca})
### מידע נוסף

-   [user.logout](logout)

[comment]: # ({/22a14fca-22a14fca})

[comment]: # ({7fd9f53c-7fd9f53c})
### מקור

CUser::login()‎ בתוך *ui/include/classes/api/services/CUser.php*.

[comment]: # ({/7fd9f53c-7fd9f53c})