[comment]: # ({084d9051-084d9051})
# user.update

[comment]: # ({/084d9051-084d9051})

[comment]: # ({dbc24bad-dbc24bad})
### 描述

`object user.update(object/array users)`

此方法允许update现有用户.

::: noteclassic
此方法适用于所有类型的用户. 调用该方法的权限可以通过用户角色设置进行撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles).

:::

::: noteclassic
用户密码强度将根据认证API定义的密码策略规则进行验证. 更多信息请参阅[Authentication
API](/manual/api/reference/authentication).

:::

[comment]: # ({/dbc24bad-dbc24bad})

[comment]: # ({8ed69eee-3b478f18})
### 参数

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

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

除[用户](object#用户)外，该方法还接受以下参数。

| 参数 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| passwd | string | 用户密码。<br><br>如果用户属于或仅被移至具有LDAP访问权限的组，则可为空string。 |
| usrgrps | array | 用于替换现有用户组的[groups](/manual/api/reference/user/create)。<br><br>用户组必须定义`usrgrpid`属性。 |
| medias | array | 用于替换现有媒体的[媒介](/manual/api/reference/user/object#媒介)。 |
| user_medias<br>(deprecated) | array | 此参数已弃用，请改用`medias`。<br>用于替换现有媒体的[媒介](/manual/api/reference/user/object#媒介)。 |

[comment]: # ({/8ed69eee-3b478f18})

[comment]: # ({4c3fb877-4c3fb877})
### 返回值

`(object)` 返回一个包含更新用户ID的object对象
该对象位于`userids`属性下

[comment]: # ({/4c3fb877-4c3fb877})

[comment]: # ({b41637d2-b41637d2})
### 示例

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({ca60eb4e-c0483e48})
#### 重命名用户

将用户重命名为John Doe.

请求:

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

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

[comment]: # ({/ca60eb4e-c0483e48})

[comment]: # ({2a24dd67-7ae4c491})
#### 更改用户角色

更改用户的角色。

请求:

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

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

[comment]: # ({/2a24dd67-7ae4c491})

[comment]: # ({1083dc26-1083dc26})
### 另请参阅

- [Authentication](/manual/api/reference/authentication)

[comment]: # ({/1083dc26-1083dc26})

[comment]: # ({bbd5a07f-bbd5a07f})
### 来源

CUser::update() 位于 *ui/include/classes/api/services/CUser.php* 文件中。

[comment]: # ({/bbd5a07f-bbd5a07f})