usergroup.get

Описание

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

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

Этот метод доступен пользователям любого типа. Разрешения на вызов метода можно отозвать в настройках ролей пользователя. Дополнительную информацию см. в разделе Роли пользователей.

Параметры

(object) Параметры, определяющие желаемый вывод.

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

Параметр Тип Описание
mfaids ID/array Возвращать только группы пользователей с указанными методами MFA.

Поведение параметра:
- поддерживается для пользователей типа Super admin
mfa_status integer Возвращать только группы пользователей с указанным статусом MFA.

Список поддерживаемых статусов см. на странице группы пользователей.
status integer Возвращать только группы пользователей с указанным статусом.

Список поддерживаемых статусов см. на странице группы пользователей.
userids ID/array Возвращать только группы пользователей, содержащие указанных пользователей.
usrgrpids ID/array Возвращать только группы пользователей с указанными ID.
selectTagFilters query Возвращать разрешения группы пользователей на основе тегов в свойстве tag_filters.
selectUsers query Возвращать пользователей из группы пользователей в свойстве users.

Ограничения в зависимости от типа пользователя см. в user.get.
selectHostGroupRights query Возвращать разрешения группы пользователей для групп узлов сети в свойстве hostgroup_rights.

Список уровней доступа к группам узлов сети см. на странице группы пользователей.
selectTemplateGroupRights query Возвращать разрешения группы пользователей для групп шаблонов в свойстве templategroup_rights.

Список уровней доступа к группам шаблонов см. на странице группы пользователей.
limitSelects integer Ограничивает количество записей, возвращаемых вложенными выборками.
output query Свойства объекта группы пользователей, которые должны быть возвращены.

Пользователи типа Admin и User могут получать только следующие свойства: usrgrpid, name, gui_access, users_status, debug_mode, mfa_status.

По умолчанию: extend.
sortfield string/array Сортировать результат по указанным свойствам.

Возможные значения: usrgrpid, name.
countOutput boolean Эти параметры описаны в справочном комментарии.
editable boolean
excludeSearch boolean
filter object
limit integer
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Возвращаемые значения

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

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

Примеры

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

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

Запрос:

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

Ответ:

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

См. также

Источник

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