object user.update(object/array users)
此方法用于 update 现有用户。
此方法适用于任何类型的用户。可以在用户角色设置中撤销调用该方法的权限。 更多信息请参见 User roles。
用户密码的强度根据身份验证 API 中定义的密码策略规则进行验证。 更多信息请参见 Authentication API。
(object/array) 待更新的用户属性。
每个用户必须定义 userid 属性,其他所有属性均为可选。仅传递的属性会被更新,其余属性将保持不变。
除 用户 外,该方法还接受以下参数。
参数 | 数据类型 | 描述 |
---|---|---|
current_passwd | string | 用户当前密码。 如果用户关联到 user directory,此参数值可为空 string。 参数行为: - 只写 - 必填(当 User object 的 passwd 已设置且用户修改自身密码时) |
usrgrps | array | 用于替换现有用户组的 User groups。 用户组只需定义 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
}
响应:
更改用户的角色。
执行请求:
响应:
CUser::update() 在 ui/include/classes/api/services/CUser.php 中。