usergroup.create

Описание

object usergroup.create(object/array userGroups)

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

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

Параметры

(object/array) Группы пользователей для создания.

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

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.

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

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

Примеры

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

Создайте группу пользователей Operation managers с запрещенным доступом к группе узлов сети "2" и добавьте в нее пользователя.

Запрос:

{
    "jsonrpc": "2.0",
    "method": "usergroup.create",
    "params": {
        "name": "Operation managers",
        "hostgroup_rights": {
            "id": "2",
            "permission": 0
        },
        "users": [
            {
                "userid": "12"
            }
        ]
    },
    "id": 1
}

Ответ:

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

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

Исходный код

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