文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 用户/ 操作用户
更新时间：2024-01-24 GMT+08:00
查看PDF
分享

操作用户

功能介绍

该接口用于操作用户，包含三种操作：锁定、解锁和重置密码（重置密码建议使用/v2/{project_id}/users/{user_id}/random-password接口，在没有通知方式的情况下必须使用/v2/{project_id}/users/{user_id}/random-password接口）。

调试

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

URI

POST /v2/{project_id}/users/{user_id}/actions

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID。

user_id

是

String

用户ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

op_type

是

String

操作类型，可选值为：

  • LOCK：锁定用户。

  • UNLOCK：解锁用户。

  • RESET_PWD：重置用户密码。

响应参数

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 404

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 405

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 503

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

  • POST /v2/0bec5db98280d2d02fd6c00c2de791ce/users/8a2c3f9479d5cf360179d622364f0008/actions

{
  "op_type" : "LOCK"
}
  • {
  "op_type" : "UNLOCK"
}
  • {
  "op_type" : "RESET_PWD"
}

响应示例

无

状态码

状态码

描述

200

正常。

400

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

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

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

500

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

503

服务不可用。

错误码

请参见错误码。

父主题： 用户

相关文档