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 żądane dane wyjściowe.

Metoda obsługuje następujące parametry.

Parametr Typ Opis
mfaids ID/array Zwraca tylko grupy użytkowników z podanymi metodami MFA.

Zachowanie parametrów:
- obsługiwane dla użytkowników typu Super admin
mfa_status integer Zwraca tylko grupy użytkowników z podanym statusem MFA.

Listę obsługiwanych statusów można znaleźć na stronie grupy użytkowników.
status integer Zwraca tylko grupy użytkowników z podanym statusem.

Listę obsługiwanych statusów można znaleźć na stronie grupy użytkowników.
userids ID/array Zwraca tylko grupy użytkowników zawierające podanych użytkowników.
usrgrpids ID/array Zwraca tylko grupy użytkowników o podanych identyfikatorach.
selectTagFilters query Zwraca uprawnienia grup użytkowników oparte na tagach we właściwości tag_filters.
selectUsers query Zwraca użytkowników z grupy użytkowników we właściwości users.

Zobacz user.get, aby sprawdzić ograniczenia zależne od typu użytkownika.
selectHostGroupRights query Zwraca uprawnienia grup użytkowników do grup hostów we właściwości hostgroup_rights.

Listę poziomów dostępu do grup hostów można znaleźć na stronie grupy użytkowników.
selectTemplateGroupRights query Zwraca uprawnienia grup użytkowników do grup szablonów we właściwości templategroup_rights.

Listę poziomów dostępu do grup szablonów można znaleźć na stronie grupy użytkownikó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.

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 opisano w komentarzu referencyjnym.
editable boolean
excludeSearch boolean
filter object
limit integer
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

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.