接口功能介绍
幂等接口,已存在用户账号重复创建会忽略并视为创建成功。
接口约束
无
URI
POST /v3/user/create
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池ID。 | d8bbd132b53a11e9b0e40242ac110002 |
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
activationType | 是 | Integer | 激活类型(1-邮件通知激活;2-管理员激活) | 2 | |
createUserList | 是 | Array of Objects | 需要创建的用户列表, 最大数量50 | createUserList | |
orgOid | 是 | String | 部门ID | org-adhij4zha35v3knu9irlg |
表 createUserList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
userAccount | 是 | String | 用户账号 | xiemushutest3 | |
否 | String | 通知邮箱。激活方式为邮件通知时,必填。 | null | ||
password | 否 | String | 用户账号密码 | abc!ABC0927 | |
userName | 否 | String | 用户名称。字符数限制:[0,20]。 | null | |
gender | 否 | String | 性别。枚举值范围:[男,女]。 | null | |
telephone | 否 | String | 固定电话。字符数限制:[0,20]。 | null | |
position | 否 | String | 职位。字符数限制:[0,50]。 | null |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 状态码。可能值: - 800:请求成功。 - 900:请求失败。 |
800 | |
error | String | 错误码。 | ||
message | String | 提示信息。 | OK. | |
returnObj | Object | 返回数据结构体。 | { } | returnObj |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
{"activationType":2,"createUserList":[{"email":null,"userAccount":"foo-create-vb79oWGt","password":"1a3!2aaaaaaaaaaaaa","userName":null,"gender":null,"telephone":null,"position":null}],"orgOid":"org-foo"}
响应示例
{"statusCode":800,"message":"OK.","returnObj":{ }}
状态码
请参考 状态码
错误码
请参考 错误码