在指定 EIAM 執行個體下建立一個 EIAM 帳戶。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| InstanceId |
string |
是 |
執行個體 ID。 |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| Username |
string |
是 |
帳戶名稱，可包含英文字母、數字、符號「_」、「.」、「@」、「-」，長度最大限制 256 字元。 |
user_001 |
| DisplayName |
string |
否 |
帳戶展示名稱，長度最大限制 128 字元。 |
name_001 |
| Password |
string |
否 |
密碼，具體格式要求參考密碼策略。 |
123456 |
| PhoneRegion |
string |
否 |
手機區號，格式為 1～6 位數字，不含「+」。 |
86 |
| PhoneNumber |
string |
否 |
手機號，格式為 6～15 位數字。 |
12345678901 |
| PhoneNumberVerified |
boolean |
否 |
手機號是否驗證，為可信手機號，手機號若設定此欄位必須設定，無特殊業務可直接設定為 true。 |
true |
|
string |
否 |
郵箱，郵箱前綴可包含大寫英文字母、小寫英文字母、數字、點、底線或中劃線，長度限制最長為 128 字元。 |
example@example.com |
|
| EmailVerified |
boolean |
否 |
郵箱是否已驗證，為可信郵箱，郵箱若設定此欄位必須設定，無特殊業務可直接設定為 true。 |
true |
| UserExternalId |
string |
否 |
帳戶外部 ID，用於與外部系統的關聯，最大長度限制 128 字元，若不設定，預設設定為帳戶 ID。 |
user_d6sbsuumeta4h66ec3il7yxxxx |
| PrimaryOrganizationalUnitId |
string |
是 |
主組織 ID。 |
ou_wovwffm62xifdziem7an7xxxxx |
| OrganizationalUnitIds |
array |
否 |
從屬組織 ID 列表，帳戶可從屬於多個組織。 |
|
|
string |
否 |
組織 ID。 |
ou_adz2vmgiwpo4tu6jtss3mynjji |
|
| Description |
string |
否 |
描述，最大長度限制 256 字元。 |
description text |
| CustomFields |
array<object> |
否 |
擴展欄位列表。 |
description |
|
object |
否 |
擴展欄位物件。 |
||
| FieldName |
string |
否 |
擴展欄位標識，需提前建立相關擴展欄位，參考主控台擴展欄位模組。 |
age |
| FieldValue |
string |
否 |
擴展欄位值，該值遵循對應擴展欄位的相關屬性限制。 |
10 |
| PasswordInitializationConfig |
object |
否 |
密碼初始化配置。 |
|
| PasswordInitializationPolicyPriority |
string |
否 |
密碼初始化策略優先級，預設不生效，取值可選範圍：
|
global |
| PasswordForcedUpdateStatus |
string |
否 |
強制修改密碼狀態，預設不啟用，取值可選範圍：
|
enabled |
| UserNotificationChannels |
array |
否 |
密碼通知管道列表。 |
sms |
|
string |
否 |
密碼通知管道，取值可選範圍：
|
sms |
|
| PasswordInitializationType |
string |
否 |
密碼初始化方式，取值可選範圍：
|
random |
| ClientToken |
string |
否 |
保證請求冪等性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元，且不能超過 64 個字元。更多資訊，請參考文件《如何保證冪等性》。 |
client-token-example |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID。 |
0441BD79-92F3-53AA-8657-F8CE4A2B912A |
| UserId |
string |
帳戶 ID。 |
user_d6sbsuumeta4h66ec3il7yxxxx |
樣本
正常返回樣本
JSON格式
{
"RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
"UserId": "user_d6sbsuumeta4h66ec3il7yxxxx"
}錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 403 | ResourceDuplicated.Username | The specified resource: Username already exist. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。