Sidebar

ru:manual:api:reference:usergroup:getobjects

usergroup.getobjects

Описание

массив usergroup.getobjects(объект фильтр)

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

Этот метод устарел и будет в будущем удален. Вместо него, пожалуйста, воспользуйтесь методом usergroup.get.

Параметры

(объект) Критерий по которому производить поиск.

В дополнение к стандартным свойствам группы пользователей, этот метод поддерживает следующие параметрами критерия поиска.

Параметр Тип Описание
name строка Имя группы пользователей.

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

(массив) Возвращается массив объектов со всеми свойствами.

Примеры

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

Получение всех данных о группе пользователей с названием “Zabbix administrators”.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "usergroup.getobjects",
    "params": {
        "name": "Zabbix administrators"
    },
    "auth": "3a57200802b24cda67c4e4010b50c065",
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "usrgrpid": "7",
            "name": "Zabbix administrators",
            "gui_access": "0",
            "users_status": "0",
            "debug_mode": "1"
        }
    ],
    "id": 1
}

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

Исходный код

CUserGroup::getObject() в frontends/php/include/classes/api/services/CUserGroup.php.