更新

Description

object usergroup.update(object/array userGroups)

此方法用于更新已存在的用户组。

此方法仅适用于Super admin(超级管理员)类型的用户。可在用户角色设置中撤销调用该方法的权限,参阅用户角色获取详情。

参数

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

必须为每个用户组定义 usrgrpid 属性,其他所有属性均为可选。 只有传入的属性会被更新,其他所有属性将保持不变。

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

参数 类型 描述
hostgroup_rights object/array 用于替换当前分配给用户组的权限的主机组权限
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.