調用CreateUser接口在指定組織下，創建新的EIAM的賬戶資源。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
請求語法
POST /v2/{instanceId}/{applicationId}/users
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Authorization | string | 是 | 認證信息。 格式：Bearer ${access_token}。 示例：Bearer ATxxxx。 | Bearer AT8csE2seYxxxxxij |
| instanceId | string | 是 | 實例 ID。 | idaas_ue2jvisn35ea5lmthk267xxxxx |
| applicationId | string | 是 | 應用 ID。 | app_mkv7rgt4d7i4u7zqtzev2mxxxx |
| body | object | 否 | 請求 body。 | |
| username | string | 是 | 賬戶名稱，可包含英文字母、數字、符號“_” 、“ .”、“@”、“-”，長度最大限制 64 字符。 | name001 |
| displayName | string | 否 | 賬戶展示名。長度限制最長為 64 字符。 | display_name001 |
| password | string | 否 | 賬戶密碼，密碼規則參考 IDaaS 控制臺密碼策略。 | xxxxx |
| phoneRegion | string | 否 | 手機地區編號,示例：中國大陸手區號為 86，不帶 00 或 +, 手機號若設置，此參數必填。 | 86 |
| phoneNumber | string | 否 | 賬戶手機號，格式為 6～15 位數字。 | 156xxxxxxx |
| phoneNumberVerified | boolean | 否 | 手機號是否驗證，手機號若設置此字段必須設置，無特殊業務可直接設置為 true。 | true |
| string | 否 | 郵箱，郵箱前綴可包含大寫英文字母、小寫英文字母、數字、點、下劃線或中劃線，長度限制最長為 64 字符。 | example@example.com | |
| emailVerified | boolean | 否 | 郵箱是否驗證，郵箱若設置此字段必須設置，無特殊業務可直接設置為 true。 | true |
| userExternalId | string | 否 | 賬戶外部 ID，用于與外部系統的關聯，最大長度限制 64 字符，若不設置，默認設置為賬戶 ID。 | user_d6sbsuumeta4h66ec3il7yxxxx |
| primaryOrganizationalUnitId | string | 是 | 主組織 ID。 | ou_wovwffm62xifdziem7an7xxxxx |
| description | string | 否 | 賬戶描述，長度限制最長為 256 字符。 | 測試賬戶 |
| passwordInitializationConfig | object | 否 | 密碼初始化配置。 | |
| passwordInitializationPolicyPriority | string | 否 | 密碼初始化策略優先級，默認不生效，取值可選范圍：
| global |
| passwordForcedUpdateStatus | string | 否 | 強制修改密碼狀態,默認不啟用，取值可選范圍：
| enabled |
| userNotificationChannels | array | 否 | 密碼通知渠道，取值可選范圍：
| |
| string | 否 | 密碼通知渠道。 | ||
| passwordInitializationType | string | 否 | 密碼初始化方式，取值可選范圍：
| random |
| customFields | array<object> | 否 | 賬戶擴展字段列表。 | |
| object | 否 | 擴展字段標識和值對象。 | ||
| fieldName | string | 否 | 擴展字段標識。類型和值域可通過控制臺查看對應擴展字段值的詳細信息。 | age |
| fieldValue | string | 否 | 擴展字段值。 | fieldValue_001 |
返回參數
示例
正常返回示例
JSON格式
{
"userId": "user_d6sbsuumeta4h66ec3il7yxxxx"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-10-24 | API 內部配置變更，不影響調用 | 查看變更詳情 |
錯誤碼
| HttpCode | Error Code | 錯誤信息 | 說明 |
|---|---|---|---|
| 400 | invalid_token | Access token is not valid | token 無效 |
| 400 | invalid_request | Access token application id not match | 請求無效，token 信息與參數應用 ID 不一致 |
| 400 | OrganizationUnitIdNotInScopes | organizationUnitId : ou_wovwffm62xifdziem7an7xxxxx not in provisioning scope! | 組織不存在或組織不在同步范圍內 |
| 404 | instance_not_found | Instance id not found: idaas_ue2jvisn35ea5lmthk267xxxxx | 實例不存在 |
| 404 | application_not_found | Application id not found: app_mkv7rgt4d7i4u7zqtzev2mxxxx | 應用不存在 |
| 403 | application_disabled | Application is disabled | 應用處于禁用狀態 |
| 403 | application_api_disabled | Application api invoke disabled | 應用 API 未開放 |
| 403 | permission_denied | Require scopes: [urn:alibaba:idaas:scope:user:manager_all] | 缺少 API 授權信息 |
| 400 | MissingParameter.Username | The specified parameter:Username is required! | 缺少賬戶名參數 |
| 400 | MissingParameter.PhoneRegion | The specified parameter:PhoneRegion is required! | 缺少手機區號參數，若已設置手機號，此為必填項 |
| 400 | MissingParameter.PhoneNumberVerified | The specified parameter:PhoneRegion is required! | 缺少手機區號是否已驗證參數，若已設置手機號，此為必填項 |
| 400 | MissingParameter.Email | The specified parameter:Email is required! | 缺少郵箱是否已驗證參數，若已設置郵箱，此為必填項 |
| 400 | MissingParameter.Username | The specified parameter:Username is required! | 缺少賬戶名參數 |
| 400 | MissingParameter.PrimaryOrganizationalUnitId | The specified parameter:PrimaryOrganizationalUnitId is required! | 缺少主組織參數 |
| 400 | InvalidParameter.PhoneNumber | The specified parameter:PhoneNumber is invalid. | 無效的手機號 |
| 400 | InvalidParameter.PhoneRegion | The specified parameter:PhoneRegion is invalid. | 無效的手機區號 |
| 400 | InvalidParameter.Password | The specified parameter:Password is invalid. | 密碼不符合規則，請參考 IDaaS 控制臺密碼規則 |
| 400 | InvalidParameter.Email | The specified parameter:Email is invalid. | 無效的郵箱 |
| 400 | InvalidParameter.DisplayName | The specified parameter:DisplayName is invalid. | 賬戶顯示名過長 |
| 400 | InvalidParameter.Description | The specified parameter:Description is invalid. | 賬戶描述過長 |
| 500 | Internal Server Error | Internal Server Error | 服務器內部錯誤 |