usergroup.delete

Описание

object usergroup.delete(array userGroupIds)

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

Группу пользователей Deprovisioned (группу пользователей, указанную для disabled_usrgrpid в разделе Authentication) нельзя удалить.

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

Параметры

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

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

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

Примеры

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

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

Запрос:

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

Ответ:

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

Источник

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