usergroup.delete

Описание

object usergroup.delete(массив userGroupIds)

Этот метод позволяет удалять группы пользователей.

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

Параметры

(массив) ID удаляемых групп пользователей.

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

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

Примеры

Удаление нескольких групп пользователей

Удалить две группы пользователей.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "usergroup.delete",
    "params": [
        "20",
        "21"
    ],
    "auth": "3a57200802b24cda67c4e4010b50c065",
    "id": 1
}

Ответ:

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

Источник

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