user.update

描述

object user.update(object/array users)

此方法用于 update 现有用户。

此方法适用于任何类型的用户。可以在用户角色设置中撤销调用该方法的权限。 更多信息请参见 User roles。

用户密码的强度根据身份验证 API 中定义的密码策略规则进行验证。 更多信息请参见 Authentication API。

参数

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

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

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

Parameter Type Description
current_passwd string 用户的当前密码。

如果用户已关联到user directory，则此参数的值可以为空字符串。

Parameter behavior:
- write-only
- 如果设置了 User object 的 passwd，且用户正在修改自己的用户密码，则为 required
usrgrps array 用于替换现有用户组的用户组。

用户组只能定义 usrgrpid 属性。
medias array 用于替换现有的、未预配的用户媒介。更新媒介时，可以省略已预配的媒介。

返回值

(object) 返回一个 object，其中包含更新用户的 ID，这些 ID 位于 userids 属性下。

示例

重命名用户

将用户重命名为 John Doe。

执行请求:

{
    "jsonrpc": "2.0",
    "method": "user.update",
    "params": {
        "userid": "1",
        "name": "John",
        "surname": "Doe"
    },
    "id": 1
}

响应：

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

更改用户角色

更改用户的角色。

执行请求:

{
    "jsonrpc": "2.0",
    "method": "user.update",
    "params": {
        "userid": "12",
        "roleid": "6"
    },
    "id": 1
}

响应：

{
    "jsonrpc": "2.0",
    "result": {
        "userids": [
            "12"
        ]
    },
    "id": 1
}

另请参阅

来源

CUser::update() 在 ui/include/classes/api/services/CUser.php 中。