更新用户

更新用户

描述

object user.update(object/array users)

此方法用于更新已经存在的用户.

任何类型的用户都可以使用此方法. 可在用户角色配置中撤销对此方法的使用. 参阅角色获取详情.

通过认证API 定义的密码策略规则来验证用户密码的强度. 更多信息请查看认证 .

参数

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

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

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

参数	类型	描述
passwd	字符串	用户的密码。如果用户属于或仅移动到具有 LDAP 访问权限的组，则可以为空字符串。
usrgrps	数组	User groups 以替换现有用户组。用户组必须定义 `usrgrpid` 属性。
medias	数组	用户媒体替换现有媒体。
user_medias （已弃用）	array	此参数已弃用，请改用“medias”。 User media 替换现有媒体。

返回值

(object) 返回一个带有userids属性（其中包含被更新用户ID）的对象.

示例

重命名用户

把用户重命名为 John Doe.

请求:

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

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

变更用户角色

变更一个用户的角色.

请求:

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

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

参考

认证

来源

CUser::update() in ui/include/classes/api/services/CUser.php.