user.update
描述
object user.update(object/array users)
此方法允许update现有用户.
此方法适用于所有类型的用户. 调用该方法的权限可以通过用户角色设置进行撤销. 更多信息请参阅User roles.
用户密码强度将根据认证API定义的密码策略规则进行验证. 更多信息请参阅Authentication API.
参数
(object/array) 待更新的用户属性。
userid 属性必须为每个用户定义，其他所有属性均为可选。仅传递的属性会被更新，其余属性将保持不变。
除用户外，该方法还接受以下参数。
| 参数 | 数据类型 | 描述 |
|---|---|---|
| passwd | string | 用户密码。 如果用户属于或仅被移至具有LDAP访问权限的组，则可为空string。 |
| usrgrps | array | 用于替换现有用户组的groups。 用户组必须定义 usrgrpid属性。 |
| medias | array | 用于替换现有媒体的媒介。 |
| user_medias (deprecated) | array | 此参数已弃用，请改用medias。用于替换现有媒体的媒介。 |
返回值
(object) 返回一个包含更新用户ID的object对象 该对象位于userids属性下
示例
重命名用户
将用户重命名为John Doe.
请求:
{ "jsonrpc": "2.0", "method": "user.update", "params": { "userid": "1", "name": "John", "surname": "Doe" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }响应:
更改用户角色
更改用户的角色。
请求:
{ "jsonrpc": "2.0", "method": "user.update", "params": { "userid": "12", "roleid": "6" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }响应:
另请参阅
来源
CUser::update() 位于 ui/include/classes/api/services/CUser.php 文件中。