[comment]: # translation:outdated

[comment]: # ({2485e0f7-2485e0f7})
# משתמש.קבל

[comment]: # ({/2485e0f7-2485e0f7})

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

`integer/array user.get(אובייקט פרמטרים)`

השיטה מאפשרת לאחזר משתמשים לפי הפרמטרים הנתונים.

::: noteclassic
שיטה זו זמינה למשתמשים מכל סוג. הרשאות
כדי לקרוא את השיטה ניתן לבטל בהגדרות תפקיד המשתמש. ראה [משתמש
תפקידים](/manual/web_interface/frontend_sections/administration/user_roles)
למידע נוסף.
:::

[comment]: # ({/36f89e39-36f89e39})

[comment]: # ({c8d70767-888512e9})
### פרמטרים

`(object)` פרמטרים המגדירים את הפלט הרצוי.

השיטה תומכת בפרמטרים הבאים.

|פרמטר|[סוג](/manual/api/reference_commentary#data_types)|תיאור|
|--|--|------|
|mediaids|string/array|החזר רק משתמשים שמשתמשים במדיה הנתונה.|
|mediatypeids|string/array|החזר רק משתמשים שמשתמשים בסוגי המדיה הנתונים.|
|userids|string/array|החזר רק משתמשים עם המזהים הנתונים.|
|usrgrpids|string/array|החזר רק משתמשים השייכים לקבוצות המשתמשים הנתונות.|
|getAccess|flag|מוסיף מידע נוסף על הרשאות משתמש.<br><br>מוסיף את המאפיינים הבאים עבור כל משתמש:<br>`gui_access` - *(מספר שלם)* שיטת האימות הקדמי של המשתמש. עיין במאפיין `gui_access` של [אובייקט קבוצת המשתמשים](/manual/api/reference/usergroup/object#user_group) לקבלת רשימה של ערכים אפשריים.<br>`debug_mode` - *(integer)* מציין אם באגים מופעל עבור המשתמש. ערכים אפשריים: 0 - איתור באגים מושבת, 1 - איתור באגים מופעל.<br>`users_status` - *(מספר שלם)* מציין אם המשתמש מושבת. ערכים אפשריים: 0 - מופעל על ידי משתמש, 1 - מושבת על ידי משתמש.|
|selectMedias|query|החזרת מדיה המשמשת את המשתמש במאפיין [medias](/manual/api/reference/user/object#media).|
|selectMediatypes|query|החזרת סוגי מדיה המשמשים את המשתמש במאפיין [mediatypes](/manual/api/reference/mediatype/object).|
|selectUsrgrps|query|החזרת קבוצות משתמשים שהמשתמש שייך אליהן במאפיין [usrgrps](/manual/api/reference/usergroup/object).|
|selectRole|query|החזרת תפקיד משתמש במאפיין [role](/manual/api/reference/role/object#role).|
|sortfield|string/array|מיין את התוצאה לפי המאפיינים הנתונים.<br><br>ערכים אפשריים הם: `userid` ו-`username`.|
|countOutput|boolean|הפרמטרים הללו, המשותפים לכל שיטות ה-'get', מתוארים בפירוט ב[פירוש ההתייחסות](/manual/api/reference_commentary#common_get_method_parameters).|
|עריכה|בוליאנית|^|
|excludeSearch|בולאני|^|
|filter|object|^|
|limit|מספר שלם|^|
|פלט|שאילתה|^|
|preservekeys|בולאני|^|
|חיפוש|אובייקט|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|בוליאני|^|
|sortorder|מחרוזת/מערך|^|
|startSearch|boolean|^|

[comment]: # ({/c8d70767-888512e9})

[comment]: # ({7223bab1-7223bab1})
### החזר ערכים

`(מספר שלם/מערך)` מחזיר אחד:

- מערך של חפצים;
- ספירת האובייקטים שאוחזרו, אם יש לפרמטר `countOutput`
     נעשה שימוש.

[comment]: # ({/7223bab1-7223bab1})

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

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

[comment]: # ({bf3b0e50-7b5c610b})
#### מאחזר משתמשים

אחזר את כל המשתמשים המוגדרים.

בַּקָשָׁה:

``` json
{
     "jsonrpc": "2.0",
     "method": "user.get",
     "params": {
         "output": "להרחיב"
     },
     "auth": "038e1d7b1735c6a5436ee9eae095879e",
     "מזהה": 1
}
```

תְגוּבָה:

``` json
{
     "jsonrpc": "2.0",
     "תוצאה": [
         {
             "userid": "1",
             "username": "מנהל",
             "name": "Zabix",
             "surname": "מנהל",
             "url": "",
             "autologin": "1",
             "autologout": "0",
             "lang": "en_GB",
             "refresh": "0s",
             "theme": "ברירת מחדל",
             "attempt_failed": "0",
             "attempt_ip": "",
             "attempt_clock": "0",
             "rows_per_page": "50",
             "timezone": "ברירת מחדל",
             "roleid": "3"
         },
         {
             "userid": "2",
             "username": "אורח",
             "שם": "",
             "שם משפחה": "",
             "url": "",
             "autologin": "0",
             "autologout": "15 מ'",
             "lang": "ברירת מחדל",
             "refresh": "שנות ה-30",
             "theme": "ברירת מחדל",
             "attempt_failed": "0",
             "attempt_ip": "",
             "attempt_clock": "0",
             "rows_per_page": "50",
             "timezone": "ברירת מחדל",
             "roleid": "4"
         },
         {
             "userid": "3",
             "username": "משתמש",
             "name": "Zabix",
             "surname": "משתמש",
             "url": "",
             "autologin": "0",
             "autologout": "0",
             "lang": "ru_RU",
             "refresh": "15s",
             "theme": "נושא אפל",
             "attempt_failed": "0",
             "attempt_ip": "",
             "attempt_clock": "0",
             "rows_per_page": "100",
             "timezone": "ברירת מחדל",
             "roleid": "1"
         }
     ],
     "מזהה": 1
}
```

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

[comment]: # ({new-746d14f7})
#### Retrieving users as *Admin*

As an *Admin* type user, retrieve detailed data about your own user and limited data for users in your user group.

Request:

```json
{
    "jsonrpc": "2.0",
    "method": "user.get",
    "params": {
        "output": "extend",
        "getAccess": true,
        "selectMedias": "extend",
        "selectMediatypes": "extend",
        "selectUsrgrps": "extend",
        "selectRole": "extend"
    },
    "id": 1
}
```

Response:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "userid": "1",
            "username": "Admin",
            "name": "Zabbix",
            "surname": "Administrator",
            "usrgrps": [
                {
                    "usrgrpid": "7",
                    "name": "Zabbix administrators",
                    "gui_access": "0",
                    "users_status": "0",
                    "debug_mode": "0"
                }
            ]
        },
        {
            "userid": "3",
            "username": "database-admin",
            "name": "John",
            "surname": "Doe",
            "url": "",
            "autologin": "0",
            "autologout": "0",
            "lang": "default",
            "refresh": "30s",
            "theme": "default",
            "attempt_failed": "0",
            "attempt_ip": "",
            "attempt_clock": "0",
            "rows_per_page": "50",
            "timezone": "default",
            "roleid": "2",
            "gui_access": "0",
            "debug_mode": "0",
            "users_status": "0",
            "usrgrps": [
                {
                    "usrgrpid": "7",
                    "name": "Zabbix administrators",
                    "gui_access": "0",
                    "users_status": "0",
                    "debug_mode": "0"
                }
            ],
            "medias": [
                {
                    "mediaid": "2",
                    "userid": "3",
                    "mediatypeid": "1",
                    "sendto": [
                        "john.doe@example.com"
                    ],
                    "active": "0",
                    "severity": "63",
                    "period": "1-7,00:00-24:00"
                }
            ],
            "mediatypes": [
                {
                    "mediatypeid": "1",
                    "type": "0",
                    "name": "Email",
                    "status": "0",
                    "description": "",
                    "maxattempts": "3"
                }
            ],
            "role": {
                "roleid": "2",
                "name": "Admin role",
                "type": "2",
                "readonly": "0"
            }
        }
    ],
    "id": 1
}
```

[comment]: # ({/new-746d14f7})

[comment]: # ({b2b58125-d85f9654})
#### אחזור נתוני משתמש

אחזר נתונים של משתמש עם מזהה "12".

בַּקָשָׁה:

``` json
{
     "jsonrpc": "2.0",
     "method": "user.get",
     "params": {
         "output": ["userid", "username"],
         "selectRole": "להרחיב",
         "userids": "12"
     },
     "auth": "038e1d7b1735c6a5436ee9eae095879e",
     "מזהה": 1
}
```

תְגוּבָה:

``` {.java}
{
   "jsonrpc": "2.0",
   "תוצאה": [
       {
           "userid": "12",
           "username": "ג'ון",
           "תפקיד": {
               "roleid": "5",
               "name": "מפעיל",
               "סוג 1",
               "readonly": "0"
           }
       }
   ],
   "מזהה": 1
}
```

[comment]: # ({/b2b58125-d85f9654})

[comment]: # ({8d892781-8d892781})
### ראה גם

- [מדיה](/manual/api/reference/user/object#media)
- [סוג מדיה](/manual/api/reference/mediatype/object#media_type)
- [קבוצת משתמשים](/manual/api/reference/usergroup/object#user_group)
- [תפקיד](/manual/api/reference/role/object#role)

[comment]: # ({/8d892781-8d892781})

[comment]: # ({842f2a42-842f2a42})
### מקור

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

[comment]: # ({/842f2a42-842f2a42})