usergroup.get

תיאור

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

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

שיטה זו זמינה למשתמשים מכל סוג. הרשאות כדי לקרוא את השיטה ניתן לבטל בהגדרות תפקיד המשתמש. ראה משתמש תפקידים למידע נוסף.

פרמטרים

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

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

פרמטר	סוג	תיאור
status	integer	החזר רק קבוצות משתמשים עם הסטטוס הנתון. עיין בדף קבוצת משתמשים לקבלת רשימה של סטטוסים נתמכים.
userids	string/array	החזר רק קבוצות משתמשים המכילות את המשתמשים הנתונים.
usrgrpids	string/array	החזר רק קבוצות משתמשים עם המזהים הנתונים.
selectTagFilters	query	החזרת הרשאות מבוססות תג של קבוצת משתמשים במאפיין tag_filters. יש לו את המאפיינים הבאים: `groupid` - (מחרוזת) מזהה של הקבוצה המארח; `tag` - (string) tag name; `value` - (string) tag value.
selectUsers	query	החזר את המשתמשים מקבוצת המשתמשים במאפיין users.
selectRights	query	החזרת זכויות קבוצת משתמשים במאפיין rights. יש לו את המאפיינים הבאים: `permission` - ( מספר שלם) רמת גישה לקבוצת המארח; `id` - (מחרוזת) מזהה של הקבוצה המארח. עיין בדף קבוצת המשתמשים לקבלת רשימה של רמות גישה לארח קבוצות.
limitSelects	integer	מגביל את מספר הרשומות המוחזרות על ידי subselects.
sortfield	string/array	מיין את התוצאה לפי המאפיינים הנתונים. ערכים אפשריים הם: `usrgrpid`, `name`.
countOutput	boolean	הפרמטרים הללו, המשותפים לכל שיטות ה-'get', מתוארים בפירוט בפירוש ההתייחסות.
עריכה	בוליאנית
excludeSearch	בולאני
filter	object
limit	מספר שלם
פלט	שאילתה
preservekeys	בולאני
חיפוש	אובייקט
searchByAny	boolean
searchWildcardsEnabled	בוליאני
sortorder	מחרוזת/מערך
startSearch	boolean

החזר ערכים

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

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

דוגמאות

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

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

בַּקָשָׁה:

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

תְגוּבָה:

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

מידע נוסף

משתמש

מקור

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

Documentation