為終端使用者建立便捷帳號。
介面說明
便捷帳號是無影專用的帳號體系,適用於不希望對接企業 AD 的簡單情境。便捷帳號資訊包括使用者名稱和郵箱,均為必填資訊。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
ecd:CreateUsers |
create |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| Users |
array<object> |
是 |
便捷帳號資訊。 |
CreateUsers |
|
object |
否 |
便捷帳號資訊。 |
||
| EndUserId |
string |
是 |
使用者名稱。自訂設定,由小寫字母、數字和底線組成,長度為 3~24 個字元。 |
alice |
|
string |
否 |
郵箱。用於接收相關郵件,如分配雲電腦的通知訊息。郵箱和手機號二選一必填。 |
username@example.com |
|
| Phone |
string |
否 |
國際站不支援手機號。 |
1381111**** |
| Password |
string |
否 |
使用者密碼。 說明
密碼長度不少於 10 位,且至少包含大寫字母、小寫字母、數字、特殊字元(除空格)中的任意三種。 |
Wuying1234 |
| OwnerType |
string |
否 |
帳號啟用類型。 枚舉值:
|
Normal |
| OrgId |
string |
否 |
使用者所屬的組織。 |
design |
| Remark |
string |
否 |
使用者備忘。 |
remark1 |
| RealNickName |
string |
否 |
使用者的顯示名稱。 |
Bean |
| GroupIdList |
array |
否 |
||
|
string |
否 |
|||
| Password |
string |
否 |
初始密碼。如果不設定,將發送重設密碼郵件到使用者郵箱。 |
Test123**** |
| AutoLockTime |
string |
否 |
自動鎖定帳號的日期。日期格式 yyyy-MM-dd HH:mm:ss。 |
2025-11-28 00:00:00 |
| IsLocalAdmin |
boolean |
否 |
是否將該便捷帳號設為本地管理員。 |
true |
| PasswordExpireDays |
string |
否 |
使用者帳號的密碼預設為永久有效,可通過此參數設定 30~365 天的密碼有效期間,當密碼到期後,終端使用者必須先修改密碼才能繼續登入。 說明
該功能目前處於邀測中,如需體驗,請提交工單申請開通。 |
30 |
| BusinessChannel |
string |
否 |
渠道 |
ENTERPRISE |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回資訊集合。 |
||
| RequestId |
string |
請求 ID。 |
1CBAFFAB-B697-4049-A9B1-67E1FC5F**** |
| CreateResult |
object |
建立便捷帳號操作的結果。 |
|
| CreatedUsers |
array<object> |
建立成功的便捷帳號資訊。 |
|
|
object |
建立成功的便捷帳號資訊。 |
||
| EndUserId |
string |
使用者名稱。 |
test1 |
|
string |
郵箱。 |
username@example.com |
|
| Phone |
string |
手機號。 |
1381111**** |
| Remark |
string |
使用者備忘。 |
remark1 |
| RealNickName |
string |
使用者的顯示名稱。 |
Bean |
| FailedUsers |
array<object> |
建立失敗的便捷帳號資訊。 |
|
|
object |
建立失敗的便捷帳號資訊。 |
||
| EndUserId |
string |
使用者名稱。 |
test2 |
|
string |
郵箱。 |
username2@example.com |
|
| Phone |
string |
手機號。 |
1390000**** |
| ErrorCode |
string |
錯誤碼。 |
ExistedEndUserId |
| ErrorMessage |
string |
錯誤資訊。 |
The username test is used by another user. |
| AllSucceed |
boolean |
樣本
正常返回樣本
JSON格式
{
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"CreateResult": {
"CreatedUsers": [
{
"EndUserId": "test1",
"Email": "username@example.com",
"Phone": "1381111****",
"Remark": "remark1",
"RealNickName": "Bean"
}
],
"FailedUsers": [
{
"EndUserId": "test2",
"Email": "username2@example.com",
"Phone": "1390000****",
"ErrorCode": "ExistedEndUserId",
"ErrorMessage": "The username test is used by another user."
}
]
},
"AllSucceed": true
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | INTERNAL_ERROR | Internal error. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。