user.update

Description

object user.update(object/array users)

这个方法允许更新存在的用户。

Description

object user.update(object/array users)

This method allows to update existing users.

Parameters

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

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

此外, standard user properties, 该方法接受以下参数。

Parameters

(object/array) User properties to be updated.

The userid property must be defined for each user, all other properties are optional. Only the passed properties will be updated, all others will remain unchanged.

Additionally to the standard user properties, the method accepts the following parameters.

返回值

(object) 在userids属性下,返回包含更新用户id对象。

Return values

(object) Returns an object containing the IDs of the updated users under the userids property.

示例

Examples

Renaming a user

把一个用户重命名为 John Doe.

Request:

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

Response:

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

来源

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