創建用戶v3
更新時間 2024-06-04 11:00:15
最近更新時間: 2024-06-04 11:00:15
分享文章
接口功能介紹
冪等接口，已存在用戶賬號重復創建會忽略并視為創建成功。
接口約束
無
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":{ }}
狀態碼
請參考
錯誤碼
請參考
