user.update

描述

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
       }

响应：

{
           "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
       }

另请参阅

Authentication

来源

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

Documentation

user.update

描述

参数

返回值

示例

重命名用户

更改用户角色

另请参阅

来源