usergroup.get

Opis

integer/array usergroup.get(object parameters)

Metoda umożliwia pobieranie grup użytkowników zgodnie z podanymi parametrami.

Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywoływania metody można odebrać w ustawieniach roli użytkownika. Zobacz Role użytkownika aby uzyskać więcej informacji.

Parametry

(object) Parametry definiujące pożądany wynik.

Metoda obsługuje następujące parametry.

Parametr	Typ	Opis
status	integer	Zwraca tylko grupy użytkowników o określonym statusie. Sprawdź stronę grup użytkowników w celu uzyskania listy obsługiwanych statusów.
userids	string/array	Zwraca tylko grupy użytkowników zawierające podanych użytkowników.
usrgrpids	string/array	Zwraca tylko grupy użytkowników o podanych identyfikatorach.
selectTagFilters	query	Zwraca uprawnienia oparte na znacznikach grup użytkowników w właściwości tag_filters. Ma następujące właściwości: `groupid` - (string) ID grupy hostów; `tag` - (string) nazwa znacznika; `value` - (string) wartość znacznika.
selectUsers	query	Zwraca użytkowników z grupy użytkowników w właściwości users.
selectRights	query	Zwraca prawa grupy użytkowników w właściwości rights. Ma następujące właściwości: `permission` - (integer) poziom dostępu do grupy hostów; `id` - (string) ID grupy hostów. Sprawdź strony grupy użytkowników w celu uzyskania listy poziomów dostępu do grup hostów.
limitSelects	integer	Ogranicza liczbę rekordów zwracanych przez podzapytania.
sortfield	string/array	Sortuje wynik według podanych właściwości. Mozliwe wartości to: `usrgrpid`, `name`.
countOutput	boolean	Te parametry, będące wspólne dla wszystkich metod `get`, są opisane szczegółowo w komentarzu referencyjnym.
editable	boolean
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Zwracane wartości

(integer/array) Zwraca jedną z opcji:

tablicę obiektów;
liczbę pobranych obiektów, jeśli parametr countOutput został wykorzystany.

Przykłady

Pobieranie włączonych grup użytkowników

Pobierz wszystkie włączone grupy użytkowników.

Zapytanie:

{
           "jsonrpc": "2.0",
           "method": "usergroup.get",
           "params": {
               "output": "extend",
               "status": 0
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Odpowiedź:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "usrgrpid": "7",
                   "name": "Zabbix administrators",
                   "gui_access": "0",
                   "users_status": "0",
                   "debug_mode": "1"
               },
               {
                   "usrgrpid": "8",
                   "name": "Guests",
                   "gui_access": "0",
                   "users_status": "0",
                   "debug_mode": "0"
               },
               {
                   "usrgrpid": "11",
                   "name": "Enabled debug mode",
                   "gui_access": "0",
                   "users_status": "0",
                   "debug_mode": "1"
               },
               {
                   "usrgrpid": "12",
                   "name": "No access to the frontend",
                   "gui_access": "2",
                   "users_status": "0",
                   "debug_mode": "0"
               },
               {
                   "usrgrpid": "14",
                   "name": "Read only",
                   "gui_access": "0",
                   "users_status": "0",
                   "debug_mode": "0"
               },
               {
                   "usrgrpid": "18",
                   "name": "Deny",
                   "gui_access": "0",
                   "users_status": "0",
                   "debug_mode": "0"
               }
           ],
           "id": 1
       }

Zobacz także

Użytkownik

Źródło

CUserGroup::get() w ui/include/classes/api/services/CUserGroup.php.

Documentation