usergroup.get

Описание

целое число/массив usergroup.get(объект параметры)

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

Параметры

(объект) Параметры задают желаемый вывод.

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

Параметр	Тип	Описание
status	целое число	Возврат групп пользователей только с заданным состоянием. Обратитесь к странице группы пользователей для получения списка поддерживаемых состояний.
userids	строка/массив	Возврат только тех групп пользователей, которые содержат заданных пользователей.
usrgrpids	строка/массив	Возврат групп пользователей только с заданными ID.
with_gui_access	целое число	Возврат групп пользователей только с заданным методом аутентификации в веб-интерфейсе. Обратитесь к странице группы пользователей для получения списка поддерживаемых методов.
selectUsers	запрос	Возврат пользователей из группы пользователей в свойстве `users`.
limitSelects	целое число	Ограничение количества записей, возвращаемых подзапросами.
sortfield	строка/массив	Сортировка результата в соответствии с заданными свойствами. Возможные значения: `usrgrpid`, `name`.
countOutput	флаг	Эти параметры являются общими для всех методов `get` и они описаны в справочных комментариях.
editable	логический
excludeSearch	флаг
filter	объект
limit	целое число
nodeids	строка/массив
output	запрос
preservekeys	флаг
search	объект
searchByAny	логический
searchWildcardsEnabled	логический
sortorder	строка/массив
startSearch	флаг

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

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

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

Примеры

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

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

Запрос:

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

Ответ:

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

Смотрите также

Исходный код

CUserGroup::get() в frontends/php/api/classes/CUserGroup.php.

Documentation