獲取登錄憑證。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。可以調(diào)用 DescribeRegions 獲取無影云電腦支持的地域列表。 | cn-hangzhou |
ClientId | string | 是 | 客戶端生成的唯一 ID。 | f4a0dc8e-1702-4728-9a60-95b27a35**** |
DirectoryId | string | 否 | 辦公網(wǎng)絡 ID,與 | cn-hangzhou+dir-885351**** |
OfficeSiteId | string | 是 | 辦公網(wǎng)絡 ID。 | cn-hangzhou+dir-885351**** |
SessionId | string | 否 | 登錄的會話 ID。
| cd45e873-650d-4d70-acb9-f996187a**** |
CurrentStage | string | 否 | 當前登錄認證階段,依次為:
| ADPassword |
EndUserId | string | 否 | 便捷用戶或 AD 用戶的用戶名。當 | alice |
Password | string | 否 | 便捷用戶或 AD 用戶的密碼。當 | Password1234 |
OldPassword | string | 否 | 舊密碼。當 | OldPassword |
NewPassword | string | 否 | 新密碼。當 | NewPassword |
AuthenticationCode | string | 否 | 虛擬 MFA 設備生成的安全碼。當 | 47**** |
ClientOS | string | 否 | 運行客戶端的設備的操作系統(tǒng)。 | Windows_NT 10.0.18363 x64 |
ClientVersion | string | 否 | 客戶端版本。若使用無影客戶端,可在客戶端登錄界面的關(guān)于對話框中查看該參數(shù)。 | 2.1.0-R-20210731.151756 |
TokenCode | string | 否 | 若已在無影云電腦控制臺開啟客戶端二次認證,且識別到當前登錄用戶有風險時,會發(fā)送該二次認證驗證碼到終端用戶郵箱。當 | 63**** |
KeepAlive | boolean | 否 | 是否保持登錄。 枚舉值:
| false |
KeepAliveToken | string | 否 | 用于保持登錄的憑證(Token),在登錄成功且用戶開啟了保持登錄選項后,接口會返回 | hide |
Uuid | string | 否 | 客戶端唯一標識。若使用無影客戶端,可在客戶端登錄界面的關(guān)于對話框中查看該參數(shù)。 | C78CA9E99315687575DD2844C1F3**** |
ClientType | string | 否 | 無影軟件客戶端類型。 枚舉值:
| WINDOWS |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"Email": "alice",
"Secret": "5OCLLKKOJU5HPBX66H3QCTWYI7MH****",
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"EndUserId": "alice",
"LoginToken": "v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****",
"NextStage": "MFAVerify",
"QrCodePng": "5OCLLKKOJU5HPBX66H3QCTWY******",
"Label": "test:wuying",
"SessionId": "d6ec166d-ab93-4286-bf7f-a18bb929****",
"Phone": "1381111****",
"TenantId": 0,
"KeepAliveToken": "006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIpEZPW",
"Industry": "edu",
"Props": {
"key": "{'dingUserName': u'\\u674e\\u66fc', 'role': 'student'}"
},
"WindowDisplayMode": "mode",
"RiskVerifyInfo": {
"Email": "user@example.com",
"LastLockDuration": 1713749778,
"Locked": "true",
"Phone": "1381111****"
},
"Reason": "null",
"PasswordStrategy": {
"TenantPasswordLength": "null",
"TenantAlternativeChars": [
"null"
]
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 | ||||||
---|---|---|---|---|---|---|---|---|
2024-06-04 | OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 看變更集 | ||||||
| ||||||||
2024-04-23 | OpenAPI 入?yún)l(fā)生變更 | 看變更集 | ||||||
| ||||||||
2024-04-10 | OpenAPI 入?yún)l(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 看變更集 | ||||||
|