[comment]: # translation:outdated

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

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

[comment]: # ({31fb9be6-ef79b8a9})
### Opis

`integer/array usergroup.get(object parameters)`

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

::: noteclassic
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](/manual/web_interface/frontend_sections/users/user_roles).
:::

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

[comment]: # ({5591bd09-4be9c06e})
### Parametry

`(object)` Parametry definiujące żądane dane wyjściowe.

Metoda obsługuje następujące parametry.

|Parametr|[Typ](/manual/api/reference_commentary#data-types)|Opis|
|--|--|------|
|mfaids|ID/array|Zwraca tylko grupy użytkowników z podanymi metodami MFA.<br><br>[Zachowanie parametrów](/manual/api/reference_commentary#parameter-behavior):<br>- *obsługiwane* dla użytkowników typu *Super admin*|
|mfa_status|integer|Zwraca tylko grupy użytkowników z podanym statusem MFA.<br><br>Listę obsługiwanych statusów można znaleźć na stronie [grupy użytkowników](object#user-group).|
|status|integer|Zwraca tylko grupy użytkowników z podanym statusem.<br><br>Listę obsługiwanych statusów można znaleźć na stronie [grupy użytkowników](object#user-group).|
|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`](/manual/api/reference/usergroup/object#tag-based-permission).|
|selectUsers|query|Zwraca użytkowników z grupy użytkowników we właściwości [`users`](/manual/api/reference/user/object#user).<br><br>Zobacz [`user.get`](/manual/api/reference/user/get), aby sprawdzić ograniczenia zależne od typu użytkownika.|
|selectHostGroupRights|query|Zwraca [uprawnienia](/manual/api/reference/usergroup/object#permission) grup użytkowników do grup hostów we właściwości `hostgroup_rights`.<br><br>Listę poziomów dostępu do grup hostów można znaleźć na stronie [grupy użytkowników](object#permission).|
|selectTemplateGroupRights|query|Zwraca [uprawnienia](/manual/api/reference/usergroup/object#permission) grup użytkowników do grup szablonów we właściwości `templategroup_rights`.<br><br>Listę poziomów dostępu do grup szablonów można znaleźć na stronie [grupy użytkowników](object#permission).|
|limitSelects|integer|Ogranicza liczbę rekordów zwracanych przez podzapytania.|
|output|query|Właściwości [obiektu grupy użytkowników](/manual/api/reference/usergroup/object), które mają zostać zwrócone.<br><br>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`.<br><br>Domyślnie: `extend`.|
|sortfield|string/array|Sortuje wynik według podanych właściwości.<br><br>Możliwe wartości: `usrgrpid`, `name`.|
|countOutput|boolean|Te parametry opisano w [komentarzu referencyjnym](/manual/api/reference_commentary#common-get-method-parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

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

[comment]: # ({7223bab1-7223bab1})
### Zwracane wartości

`(integer/array)` Zwraca:

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

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

[comment]: # ({b41637d2-b41637d2})
### Przykłady

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

[comment]: # ({e685bea9-62cd5d8e})
#### Pobieranie włączonych grup użytkowników

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

[Żądanie](/manual/api#performing-requests):

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

Odpowiedź:

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

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

[comment]: # ({039ccba1-039ccba1})
### Zobacz także

-   [Użytkownik](/manual/api/reference/user/object#user)

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

[comment]: # ({e72b2ac9-e72b2ac9})
### Źródło

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

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