usergroup.update

Описание

object usergroup.update(object/array userGroups)

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

Этот метод доступен только для типа пользователя Super admin. Разрешения на вызов метода можно отозвать в настройках роли пользователя. См. Роли пользователей для получения дополнительной информации.

Параметры

(object/array) Свойства групп пользователей, которые необходимо обновить.

Свойство usrgrpid должно быть определено для каждой группы пользователей, все остальные свойства являются необязательными. Будут обновлены только переданные свойства, все остальные останутся без изменений.

Помимо стандартных свойств группы пользователей, метод принимает следующие параметры.

Parameter Type Description
hostgroup_rights object/array Права доступа к группам узлов сети, которыми необходимо заменить текущие права доступа, назначенные группе пользователей.
proxies object/array Прокси, которые необходимо связать с группой пользователей.
Прокси должны иметь только свойство proxyid.
proxy_groups object/array Группы прокси, которые необходимо связать с группой пользователей.
Группы прокси должны иметь только свойство proxy_groupid.
templategroup_rights object/array Права доступа к группам шаблонов, которыми необходимо заменить текущие права доступа, назначенные группе пользователей.
tag_filters array Права доступа на основе тегов, которыми необходимо заменить текущие права доступа, назначенные группе пользователей.
users object/array Пользователи, которыми необходимо заменить текущих пользователей, назначенных группе пользователей.

Пользователь должен иметь только свойство userid.

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

(объект) Возвращает объект, который содержит ID обновленных групп пользователей, указанных в свойстве usrgrpids.

Примеры

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

Включите группу пользователей и предоставьте ей доступ на чтение и запись к группам узлов сети "2" и "4".

Запрос:

{
    "jsonrpc": "2.0",
    "method": "usergroup.update",
    "params": {
        "usrgrpid": "17",
        "users_status": "0",
        "hostgroup_rights": [
            {
                "id": "2",
                "permission": 3
            },
            {
                "id": "4",
                "permission": 3
            }
        ]
    },
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": {
        "usrgrpids": [
            "17"
        ]
    },
    "id": 1
}

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

Источник

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