usergroup.update

Description

объект usergroup.update(объект/массив ГруппыПользователей)

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

Параметры

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

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

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

Параметр	Тип	Описание
rights	объект/массив	Права доступа, которые заменят текущие права назначенные на группу пользователей.
tag_filters	массив	Права доступа на основе тегов, которые назначаются на группу
userids	строка/массив	ID пользователей, которые заменят текущих пользователей в группе.

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

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

Примеры

Деактивация группы пользователей

Деактивация группы пользователей.

Запрос:

{
           "jsonrpc": "2.0",
           "method": "usergroup.update",
           "params": {
               "usrgrpid": "17",
               "users_status": "1"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Ответ:

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

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

Права доступа

Исходный код

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

Documentation