更新时间:2024-01-11 GMT+08:00

修改用户信息

功能介绍

该接口用于修改桌面用户信息。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

PUT /v2/{project_id}/users/{user_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

user_id

String

用户ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Content-Type

String

发送的实体的MIME类型,如:application/json。

表3 请求Body参数

参数

是否必选

参数类型

描述

description

String

用户描述。

user_email

String

用户邮箱。

user_phone

String

手机号。

active_type

String

激活类型,默认为用户激活。

  • USER_ACTIVATE: 用户激活

  • ADMIN_ACTIVATE: 管理员激活

account_expires

String

账户过期时间,0表示永远不过期。

enable_change_password

Boolean

是否允许修改密码,true表示允许,false表示不允许。

next_login_change_password

Boolean

下次登录是否需要重置密码,true表示需要重置密码,false表示不需要。

password_never_expired

Boolean

密码是否永不过期,true表示密码永不过期,false表示密码会过期。

disabled

Boolean

账户是否禁用,true表示被禁用,false表示未禁用。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

id

String

用户id。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 405

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码: 503

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

PUT /v2/0bec5db98280d2d02fd6c00c2de791ce/users/8a2c3f9579d240820179d51e6caf0001

{
  "user_email" : "test@huawei.com",
  "description" : "api测试用户。"
}

响应示例

状态码: 200

修改用户信息响应。

{
  "id" : "8a2c3f9579d240820179d51e6caf0001"
}

状态码

状态码

描述

200

修改用户信息响应。

400

由于包含语法错误,当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

请求中指定的方法不被允许。

500

服务内部错误,具体返回错误码请参见错误码说明。

503

服务不可用。

错误码

请参见错误码