usergroup.create

Описание

object usergroup.create(object/array userGroups)

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

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

Параметры

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

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

Параметр Тип Описание
hostgroup_rights object/array Права доступа к группам узлов сети, назначаемые группе пользователей.
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.