為終端用戶創建便捷賬號。
接口說明
便捷賬號是無影專用的賬號體系,適用于不希望對接企業 AD 的簡單場景。便捷賬號信息包括用戶名、郵箱和手機號。其中,用戶名為必填信息,郵箱和手機號至少填寫一項。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
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 |
Password | string | 否 | 初始密碼。如果不設置,將發送重置密碼郵件到用戶郵箱。 | Test123**** |
AutoLockTime | string | 否 | 自動鎖定賬號的日期。 | 2023-03-03 |
IsLocalAdmin | boolean | 否 | 是否將該便捷賬號設為本地管理員。 | true |
PasswordExpireDays | string | 否 | 用戶賬號的密碼默認為永久有效,可通過此參數設置 30~365 天的密碼有效期,當密碼到期后,終端用戶必須先修改密碼才能繼續登錄。 說明
該功能目前處于邀測中,如需體驗,請提交工單申請開通。
| 30 |
返回參數
示例
正常返回示例
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."
}
]
}
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 |
---|---|---|
400 | INTERNAL_ERROR | Internal error. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-04-09 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2024-01-16 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-08-31 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2021-04-02 | 新增 OpenAPI | 查看變更詳情 |