更新

描述

object usergroup.update(object/array userGroups)

此方法允许您更新现有的用户组。

此方法仅适用于 Super admin 用户类型。 调用该方法的权限可以在用户角色设置中撤销。有关更多信息，请参见 用户 角色。

参数

(object/array) 要更新的用户组属性。

必须为每个用户组定义 usrgrpid 属性，所有其他属性均为可选属性。仅更新传递的属性，其他属性保持不变。

除标准用户组属性外，该方法还接受以下参数。

参数 类型 描述
hostgroup_rights object/array 用于替换当前分配给用户组的主机组权限。
proxies object/array 要关联到用户组的 proxy。
proxy 只能定义 proxyid 属性。
proxy_groups object/array 要关联到用户组的 proxy 组。
proxy 组只能定义 proxy_groupid 属性。
templategroup_rights object/array 用于替换当前分配给用户组的模板组权限。
tag_filters array 用于替换当前分配给用户组的基于标签的权限。
users object/array 用于替换当前分配给用户组的用户。

用户只能定义 userid 属性。

返回值

(object) 返回一个带有usrgrpids属性（其中包含被更新用户组ID）的对象。

示例

启用用户组并更新权限

启用一个用户组，并为其提供对主机组“2”和“4”的读写权限。

请求:

{
    "jsonrpc": "2.0",
    "method": "usergroup.update",
    "params": {
        "usrgrpid": "17",
        "users_status": "0",
        "hostgroup_rights": [
            {
                "id": "2",
                "permission": 3
            },
            {
                "id": "4",
                "permission": 3
            }
        ]
    },
    "id": 1
}

响应:

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

参考

来源

CUserGroup::update() in ui/include/classes/api/services/CUserGroup.php.