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

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

[comment]: # ({31fb9be6-ef79b8a9})
### Описание

`integer/array usergroup.get(параметры объекта)`

Метод позволяет получить группы пользователей в соответствии с заданными параметрами.

::: noteclassic
Этот метод доступен пользователям любого типа.
Разрешения на вызов метода можно отозвать в настройках ролей пользователя.
Дополнительную информацию см. в разделе [Роли пользователей](/manual/web_interface/frontend_sections/users/user_roles).
:::

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

[comment]: # ({5591bd09-4be9c06e})
### Параметры

`(object)` Параметры, определяющие требуемый результат.

Метод поддерживает следующие параметры.

|Parameter|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|mfaids|ID/array|Возвращать только группы пользователей с указанными методами MFA.<br><br>[Поведение параметра](/manual/api/reference_commentary#parameter-behavior):<br>- *supported* для пользователей типа *Super admin*|
|mfa_status|integer|Возвращать только группы пользователей с указанным статусом MFA.<br><br>Список поддерживаемых статусов см. на [странице группы пользователей](object#user-group).|
|status|integer|Возвращать только группы пользователей с указанным статусом.<br><br>Список поддерживаемых статусов см. на [странице группы пользователей](object#user-group).|
|userids|ID/array|Возвращать только группы пользователей, которые содержат указанных пользователей.|
|usrgrpids|ID/array|Возвращать только группы пользователей с указанными ID.|
|selectTagFilters|query|Возвращать разрешения группы пользователей на основе тегов в свойстве [`tag_filters`](/manual/api/reference/usergroup/object#tag-based-permission).|
|selectUsers|query|Возвращать пользователей из группы пользователей в свойстве [`users`](/manual/api/reference/user/object#user).<br><br>См. [`user.get`](/manual/api/reference/user/get) для ограничений, основанных на типе пользователя.|
|selectHostGroupRights|query|Возвращать [разрешения](/manual/api/reference/usergroup/object#permission) группы пользователей для групп узлов сети в свойстве `hostgroup_rights`.<br><br>Список уровней доступа к группам узлов сети см. на [странице группы пользователей](object#permission).|
|selectTemplateGroupRights|query|Возвращать [разрешения](/manual/api/reference/usergroup/object#permission) группы пользователей для групп шаблонов в свойстве `templategroup_rights`.<br><br>Список уровней доступа к группам шаблонов см. на [странице группы пользователей](object#permission).|
|limitSelects|integer|Ограничивает количество записей, возвращаемых подзапросами.|
|output|query|Свойства [объекта группы пользователей](/manual/api/reference/usergroup/object), которые нужно вернуть.<br><br>Пользователи типов *Admin* и *User* могут получать только следующие свойства: `usrgrpid`, `name`, `gui_access`, `users_status`, `debug_mode`, `mfa_status`.<br><br>По умолчанию: `extend`.|
|sortfield|string/array|Сортировать результат по указанным свойствам.<br><br>Возможные значения: `usrgrpid`, `name`.|
|countOutput|boolean|Эти параметры описаны в [справочном комментарии](/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})
### Возвращаемые значения

`(целое число/массив)` Возвращает либо:

- · массив объектов;
- · количество извлеченных объектов, если использовался параметр `countOutput`.

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

[comment]: # ({b41637d2-b41637d2})
### Примеры

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

[comment]: # ({e685bea9-62cd5d8e})
#### Получение включенных групп пользователей

Получить все включенные группы пользователей.

[Запрос](/manual/api#performing-requests):

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

Ответ:

```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})
### См. также

-   [User](/manual/api/reference/user/object#user)

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

[comment]: # ({e72b2ac9-e72b2ac9})
### Источник

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

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