usergroup.update

Описание

object usergroup.update(объект/массив userGroups)

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

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

Параметры

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

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

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

Parameter Type Description
hostgroup_rights object/array Права на группу узлов сети, permissions, которые заменят текущие права, назначенные группе пользователей.
templategroup_rights object/array Права на группу шаблонов, permissions, которые заменят текущие права, назначенные группе пользователей.
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.