[comment]: # translation:outdated

[comment]: # ({ce8d2bd2-ce8d2bd2})
# usergroup.get

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

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

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

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

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

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

[comment]: # ({ec24a83b-4be9c06e})
### פרמטרים

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

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

|פרמטר|[סוג](/manual/api/reference_commentary#data_types)|תיאור|
|--|--|------|
|status|integer|החזר רק קבוצות משתמשים עם הסטטוס הנתון.<br><br>עיין בדף [קבוצת משתמשים](object#user_group) לקבלת רשימה של סטטוסים נתמכים.|
|userids|string/array|החזר רק קבוצות משתמשים המכילות את המשתמשים הנתונים.|
|usrgrpids|string/array|החזר רק קבוצות משתמשים עם המזהים הנתונים.|
|selectTagFilters|query|החזרת הרשאות מבוססות תג של קבוצת משתמשים במאפיין [tag\_filters](/manual/api/reference/usergroup/object#tag_based_permission).<br><br>יש לו את המאפיינים הבאים:<br>` groupid` - (מחרוזת) מזהה של הקבוצה המארח;<br>`tag` - (string) tag name;<br>`value` - (string) tag value.|
|selectUsers|query|החזר את המשתמשים מקבוצת המשתמשים במאפיין [users](/manual/api/reference/user/object#user).|
|selectRights|query|החזרת זכויות קבוצת משתמשים במאפיין [rights](/manual/api/reference/usergroup/object#permission).<br><br>יש לו את המאפיינים הבאים:<br>`permission` - ( מספר שלם) רמת גישה לקבוצת המארח;<br>`id` - (מחרוזת) מזהה של הקבוצה המארח.<br><br>עיין בדף [קבוצת המשתמשים](object#permission) לקבלת רשימה של רמות גישה לארח קבוצות.|
|limitSelects|integer|מגביל את מספר הרשומות המוחזרות על ידי subselects.|
|sortfield|string/array|מיין את התוצאה לפי המאפיינים הנתונים.<br><br>ערכים אפשריים הם: `usrgrpid`, `name`.|
|countOutput|boolean|הפרמטרים הללו, המשותפים לכל שיטות ה-'get', מתוארים בפירוט ב[פירוש ההתייחסות](/manual/api/reference_commentary#common_get_method_parameters).|
|עריכה|בוליאנית|^|
|excludeSearch|בולאני|^|
|filter|object|^|
|limit|מספר שלם|^|
|פלט|שאילתה|^|
|preservekeys|בולאני|^|
|חיפוש|אובייקט|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|בוליאני|^|
|sortorder|מחרוזת/מערך|^|
|startSearch|boolean|^|

[comment]: # ({/ec24a83b-4be9c06e})

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

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

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

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

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

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

[comment]: # ({a3c99a8f-62cd5d8e})
#### מאחזר קבוצות משתמשים מופעלות

אחזר את כל קבוצות המשתמשים המופעלות.

בַּקָשָׁה:

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

תְגוּבָה:

``` json
{
     "jsonrpc": "2.0",
     "תוצאה": [
         {
             "usrgrpid": "7",
             "name": "מנהלי Zabbix",
             "gui_access": "0",
             "users_status": "0",
             "debug_mode": "1"
         },
         {
             "usrgrpid": "8",
             "name": "אורחים",
             "gui_access": "0",
             "users_status": "0",
             "debug_mode": "0"
         },
         {
             "usrgrpid": "11",
             "name": "מצב ניפוי באגים מופעל",
             "gui_access": "0",
             "users_status": "0",
             "debug_mode": "1"
         },
         {
             "usrgrpid": "12",
             "name": "אין גישה ל-frontend",
             "gui_access": "2",
             "users_status": "0",
             "debug_mode": "0"
         },
         {
             "usrgrpid": "14",
             "name": "קריאה בלבד",
             "gui_access": "0",
             "users_status": "0",
             "debug_mode": "0"
         },
         {
             "usrgrpid": "18",
             "name": "דחה",
             "gui_access": "0",
             "users_status": "0",
             "debug_mode": "0"
         }
     ],
     "מזהה": 1
}
```

[comment]: # ({/a3c99a8f-62cd5d8e})

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

-   [משתמש](/manual/api/reference/user/object#user)

[comment]: # ({/039ccba1-039ccba1})

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

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

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