更新

说明

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

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

参数

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

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

除了标准用户属性之外, 该方法接受以下参数。

属性类型说明
passwdstring用户的密码。
usrgrpsarray用户组来替换现有的用户组。

用户组ID必须是存在的 usrgrpid
user_mediasarray新的媒体用于替换旧的。

返回值

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

示例

重命名用户

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

Request:

  1. {
  2. "jsonrpc": "2.0",
  3. "method": "user.update",
  4. "params": {
  5. "userid": "1",
  6. "name": "John",
  7. "surname": "Doe"
  8. },
  9. "auth": "038e1d7b1735c6a5436ee9eae095879e",
  10. "id": 1
  11. }

Response:

  1. {
  2. "jsonrpc": "2.0",
  3. "result": {
  4. "userids": [
  5. "1"
  6. ]
  7. },
  8. "id": 1
  9. }

来源

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