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

usergroup.get

Описание

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

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

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

Параметры

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

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

Параметр Тип Описание
status целое число Возврат групп пользователей только с заданным состоянием.

Обратитесь к странице группы пользователей для получения списка поддерживаемых состояний.
userids строка/массив Возврат только тех групп пользователей, которые содержат заданных пользователей.
usrgrpids строка/массив Возврат групп пользователей только с заданными ID.
with_gui_access целое число Возврат групп пользователей только с заданным методом аутентификации в веб-интерфейсе.

Обратитесь к странице группы пользователей для получения списка поддерживаемых методов.
selectTagFilters запрос Возврат прав доступа на основе тегов группы пользователей в свойстве tag_filters.

Имеет следующие свойства:
groupid - (строка) ID группы пользователей;
tag - (строка) имя тега;
value - (строка) значение тега.
selectUsers запрос Возврат пользователей из группы пользователей в свойстве users.
selectRights запрос Возврат прав доступа группы узлов сети в свойстве rights.

Имеет следующие свойства:
permission - (целое число) уровень прав доступа к группе узлов сети;
id - (строка) ID группы узлов сети.

Обратитесь к странице группы пользователей для получения списка уровней прав доступа к группам узлов сети.
limitSelects целое число Ограничение количества записей, возвращаемых подзапросами.
sortfield строка/массив Сортировка результата в соответствии с заданными свойствами.

Возможные значения: usrgrpid, name.
countOutput логический Эти параметры являются общими для всех методов get и они описаны в справочных комментариях.
editable логический
excludeSearch логический
filter объект
limit целое число
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() в ui/include/classes/api/services/CUserGroup.php.