批量创建用户
功能介绍
该接口用于批量创建用户。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v2/{project_id}/users/batch-create
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
Content-Type |
是 |
String |
发送的实体的MIME类型，如：application/json。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
users |
是 |
Array of CreateUserRequest objects |
创建单个用户请求。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
user_name |
是 |
String |
用户名称。 |
user_email |
否 |
String |
用户邮箱。 |
account_expires |
否 |
String |
账户过期时间，0表示永远不过期。时间格式：yyyy-MM-ddTHH:mm:ssZ或yyyy-MM-ddTHH:mm:ss.SSSZ。 |
active_type |
否 |
String |
激活类型，默认为用户激活。
|
user_phone |
否 |
String |
用户手机号。 |
password |
否 |
String |
用户初始密码。管理员激活模式需要输入。 |
enable_change_password |
否 |
Boolean |
是否允许用户更改密码，缺省值为true，后续此字段无效，创建时都为true。 |
next_login_change_password |
否 |
Boolean |
下次登录是否必须更改密码，缺省值为true。后续此字段无效，创建时都为true。 |
group_ids |
否 |
Array of strings |
用户组的专有ID列表。 |
description |
否 |
String |
用户描述，字符串长度区间[0, 255]。 |
alias_name |
否 |
String |
别名。 |
响应参数
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码： 401
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码： 403
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码： 404
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码： 405
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码： 500
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码： 503
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
POST /v2/0bec5db98280d2d02fd6c00c2de791ce/users/batch-create
{
"users" : [ {
"user_name" : "abc",
"user_email" : "xxx@mail.com"
} ]
}
响应示例
无
状态码
状态码 |
描述 |
|---|---|
200 |
创建云桌面用户响应。 |
400 |
由于包含语法错误，当前请求无法被服务器理解。 |
401 |
鉴权失败。 |
403 |
没有操作权限。 |
404 |
找不到资源。 |
405 |
请求中指定的方法不被允许。 |
500 |
服务内部错误，具体返回错误码请参见错误码说明。 |
503 |
服务不可用。 |
错误码
请参见错误码。
