更新用户

描述

object user.update(object/array users)

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

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

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

参数

(object/array) 需要更新的用户参数.

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

除了 用户标准属性, 此方法还接受以下参数.

参数类型描述
passwdstring用户的密码.

如果用户属于或仅加入那些具有LDAP认证的用户组,可以是空字符串.
usrgrpsarray替换当前的用户组的用户组 .

用户组必须定义 usrgrpid 属性.
mediasarray替换当前用户媒介的用户媒介 .

返回值

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

示例

重命名用户

把用户重命名为 John Doe.

请求:

  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. }

返回:

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

变更用户角色

变更一个用户的角色.

请求:

  1. {
  2. "jsonrpc": "2.0",
  3. "method": "user.update",
  4. "params": {
  5. "userid": "12",
  6. "roleid": "6"
  7. },
  8. "auth": "038e1d7b1735c6a5436ee9eae095879e",
  9. "id": 1
  10. }

返回:

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

参考

来源

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