usergroup.get

Opis

integer/array usergroup.get(object parameters)

Ta 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 tej metody mogą zostać odebrane w ustawieniach roli użytkownika. Więcej informacji znajduje się w sekcji Role użytkowników.

Parametry

(object) Parametry definiujące oczekiwany wynik.

Metoda obsługuje następujące parametry.

Parameter Type Description
mfaids ID/array Zwracaj tylko grupy użytkowników z podanymi metodami MFA.

Zachowanie parametru:
- obsługiwane dla użytkowników typu Super admin (od Zabbix 7.0.9)
mfa_status integer Zwracaj tylko grupy użytkowników z podanym statusem MFA.

Zapoznaj się ze stroną grupy użytkowników, aby uzyskać listę obsługiwanych statusów.
status integer Zwracaj tylko grupy użytkowników z podanym statusem.

Zapoznaj się ze stroną grupy użytkowników, aby uzyskać listę obsługiwanych statusów.
userids ID/array Zwracaj tylko grupy użytkowników zawierające podanych użytkowników.
usrgrpids ID/array Zwracaj tylko grupy użytkowników o podanych identyfikatorach.
selectTagFilters query Zwracaj uprawnienia grupy użytkowników oparte na tagach w właściwości tag_filters.
selectUsers query Zwracaj użytkowników z grupy użytkowników w właściwości users.

Informacje o ograniczeniach zależnych od typu użytkownika znajdują się w opisie user.get.
selectHostGroupRights query Zwracaj uprawnienia grupy użytkowników do grup hostów w właściwości hostgroup_rights.

Zapoznaj się ze stroną grupy użytkowników, aby uzyskać listę poziomów dostępu do grup hostów.
selectTemplateGroupRights query Zwracaj uprawnienia grupy użytkowników do grup szablonów w właściwości templategroup_rights.

Zapoznaj się ze stroną grupy użytkowników, aby uzyskać listę poziomów dostępu do grup szablonów.
limitSelects integer Ogranicza liczbę rekordów zwracanych przez podzapytania.
output query Właściwości obiektu grupy użytkowników, które mają zostać zwrócone.

Od Zabbix 7.0.9 użytkownicy typu Admin i User mogą pobierać tylko następujące właściwości: usrgrpid, name, gui_access, users_status, debug_mode, mfa_status.

Domyślnie: extend.
sortfield string/array Sortuje wynik według podanych właściwości.

Możliwe wartości: usrgrpid, name.
countOutput boolean Te parametry są opisane w komentarzu referencyjnym.
editable boolean
excludeSearch boolean
filter object
limit integer
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectRights
(deprecated)		 query Ten parametr jest przestarzały, zamiast niego użyj selectHostGroupRights lub selectTemplateGroupRights.
Zwracaj uprawnienia grupy użytkowników w właściwości rights.
Zapoznaj się ze stroną grupy użytkowników, aby uzyskać listę poziomów dostępu do grup hostów.

Zwracane wartości

(integer/array) Zwraca:

  • tablicę obiektów;
  • liczbę pobranych obiektów, jeśli został użyty parametr countOutput.

Przykłady

Pobieranie włączonych grup użytkowników

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

Żądanie:

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

Odpowiedź:

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

Zobacz także

Źródło

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