全部產品
Search

搜尋本產品

    Elastic Desktop Service：GetLoginToken

    文件中心

    Elastic Desktop Service：GetLoginToken

    更新時間：Jul 16, 2026

    取得登入憑證。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    當前API暫無授權資訊透出。

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    是

    地域 ID。可以呼叫 DescribeRegions 取得無影雲電腦支援的地域清單。

    cn-hangzhou
    ClientId

    string

    是

    用戶端產生的唯一 ID。

    f4a0dc8e-1702-4728-9a60-95b27a35****
    DirectoryId

    string

    否

    辦公網路 ID，與 OfficeSiteId 含義相同。建議停止使用 DirectoryId，改為使用 OfficeSiteId。DirectoryId 和 OfficeSiteId 只能填寫一個，不可同時填寫。

    cn-hangzhou+dir-885351****
    OfficeSiteId

    string

    否

    辦公網路 ID。

    cn-hangzhou+dir-885351****
    SessionId

    string

    否

    登入的工作階段 ID。

    • 若未綁定虛擬 MFA 裝置或者未開啟用戶端二次驗證，則不需要填寫 SessionId。

    • 若已綁定虛擬 MFA 裝置或者已開啟用戶端二次驗證，則在 ADPassword 之後的登入驗證階段需要填寫 SessionId。可從便捷帳號驗證（即 GetLoginToken 請求處於 ADPassword 階段）的傳回結果中取得 SessionId。

    cd45e873-650d-4d70-acb9-f996187a****
    CurrentStage

    string

    否

    目前登入驗證階段，依次為：

    • ADPassword：驗證使用者資訊。當使用便捷帳號或者 AD 帳號的帳密驗證時填寫此值。

    • MFABind：綁定虛擬 MFA 裝置。

    • MFAVerify：驗證虛擬 MFA 裝置產生的安全碼。

    • TokenVerify：用戶端二次驗證。

    • ChangePassword：修改使用者密碼。

    • KeepAliveVerify：KeepAliveToken 有效時，可用於換取 LoginToken。

    ADPassword
    EndUserId

    string

    否

    便捷使用者或 AD 使用者的使用者名稱。當 CurrentStage 為 ADPassword 時必填。

    alice
    Password

    string

    否

    便捷使用者或 AD 使用者的密碼。當 CurrentStage 為 ADPassword 時必填。

    Password1234
    OldPassword

    string

    否

    舊密碼。當 CurrentStage 為 ChangePassword 時必填。

    OldPassword
    NewPassword

    string

    否

    新密碼。當 CurrentStage 為 ChangePassword 時必填。

    NewPassword
    AuthenticationCode

    string

    否

    虛擬 MFA 裝置產生的安全碼。當 CurrentStage 為 MFAVerify 時必填。

    47****
    ClientOS

    string

    否

    執行用戶端的裝置作業系統。

    Windows_NT 10.0.18363 x64
    ClientVersion

    string

    否

    用戶端版本。若使用無影用戶端，可在用戶端登入介面的關於對話方塊中檢視該參數。

    2.1.0-R-20210731.151756
    TokenCode

    string

    否

    若已在無影雲電腦主控台開啟用戶端二次驗證，且識別到目前登入使用者有風險時，會傳送該二次驗證碼至終端使用者電子郵件信箱。當 CurrentStage 為 TokenVerify 時必填。

    63****
    KeepAlive

    boolean

    否

    是否保持登入。

    枚舉值：

    • null :

      不保持登入 [預設值]

    • true :

      保持登入。

    • false :

      不保持登入。

    false
    KeepAliveToken

    string

    否

    用於保持登入的憑證（Token），在登入成功且使用者開啟了保持登入選項後，介面會傳回 KeepAliveToken，在 KeepAliveToken 有效期間內可以呼叫 GetLoginToken 介面並將 CurrentStage 設為 KeepAliveVerify 來換取登入憑證（LoginToken）。當 CurrentStage 為 KeepAliveVerify 時，KeepAliveToken 必填。

    hide
    Uuid

    string

    否

    用戶端唯一識別碼。若使用無影用戶端，可在用戶端登入介面的關於對話方塊中檢視該參數。

    C78CA9E99315687575DD2844C1F3****
    ClientType

    string

    否

    無影軟體用戶端類型。

    枚舉值：

    • HTML5 :

      Web 用戶端。

    • WINDOWS :

      Windows 用戶端。

    • MACOS :

      macOS 用戶端。

    • IOS :

      iOS 用戶端。

    • ANDROID :

      Android 用戶端。

    WINDOWS
    AvailableFeatures

    object

    否

    string

    否

    ClientName

    string

    否

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    傳回資訊集合。

    Email

    string

    使用者電子郵件信箱。在登入後隨 LoginToken 傳回。

    • 如果是便捷使用者，傳回建立便捷使用者時設定的電子郵件信箱。

    • 如果是 AD 使用者，傳回以下形式：使用者名稱@AD 網域名稱。

    alice
    Secret

    string

    綁定虛擬 MFA 裝置時的金鑰。用於 MFABind 階段。

    說明

    關於各驗證階段的詳細資訊，請參閱本介面請求參數 CurrentStage 的參數說明。

    5OCLLKKOJU5HPBX66H3QCTWYI7MH****
    RequestId

    string

    請求 ID。

    1CBAFFAB-B697-4049-A9B1-67E1FC5F****
    EndUserId

    string

    便捷帳號使用者名稱或 AD 使用者名稱。

    alice
    LoginToken

    string

    登入憑證。

    v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
    NextStage

    string

    預期的下一階段。例如，若管理員在無影雲電腦主控台開啟了 MFA 驗證，則當使用者名稱密碼驗證通過後（即 ADPassword 階段後），該參數會傳回 MFAVerify，表示此時需要做 MFA 驗證。

    說明

    關於各驗證階段的詳細資訊，請參閱本介面請求參數 CurrentStage 的參數說明。

    MFAVerify
    QrCodePng

    string

    綁定虛擬 MFA 裝置時的金鑰 QR Code。使用 Base64 編碼。可以為空，用於 MFABind 階段。

    說明

    關於各驗證階段的詳細資訊，請參閱本介面請求參數 CurrentStage 的參數說明。

    5OCLLKKOJU5HPBX66H3QCTWY******
    Label

    string

    便捷使用者屬性。如果是 AD 使用者，則傳回空值。

    test:wuying
    SessionId

    string

    工作階段 ID。僅在同一工作階段第一次呼叫 GetLoginToken 時傳回。需要多次驗證時，後續的階段需要傳入該參數。

    說明

    關於各驗證階段的詳細資訊，請參閱本介面請求參數 CurrentStage 的參數說明。

    d6ec166d-ab93-4286-bf7f-a18bb929****
    Phone

    string

    便捷使用者的手機號碼。如果是 AD 使用者，則傳回空值。

    1381111****
    TenantId

    integer

    阿里雲帳號 ID。硬體終端識別使用。

    166353906220****
    KeepAliveToken

    string

    用於保持登入的憑證（Token），在登入成功且使用者開啟了保持登入選項後，介面會傳回 KeepAliveToken。若未開啟保持登入選項，則傳回空值。

    006YwvYMsesWWsDBZnVB+Wq9AvJDVIqOY3YCktvtb7+KxMb3ClnNlV8+l/knhZYrXUmeP06IzkjF+IgcZ3vZKOyMprDyFHjCy1r27FRE/U7+geWCl8iQ+yF8GaCRHfJEkC2+ROs93HkT4tfHxyY1J8W7O7ZQGUC/cdCvm+cCP6FIy73IUuPuVR6PcKYXIpEZPW
    Industry

    string
    說明

    內部專用欄位，不對外開放使用。

    edu
    Props

    object
    說明

    內部專用欄位，不對外開放使用。

    string
    說明

    內部專用欄位，不對外開放使用。

    {'dingUserName': u'\u674e\u66fc', 'role': 'student'}
    WindowDisplayMode

    string
    說明

    內部專用欄位，不對外開放使用。

    mode
    RiskVerifyInfo

    object

    登入風險識別相關資訊。

    Email

    string

    觸發身分核驗時，透過該電子郵件信箱進行驗證。

    user@example.com
    LastLockDuration

    integer

    帳號鎖定時間。

    1713749778
    Locked

    string

    帳號是否已鎖定。

    枚舉值：

    • true :

      是。

    • false :

      否。

    true
    Phone

    string

    觸發身分核驗時，透過該手機號碼進行驗證。

    1381111****
    Reason

    string
    說明

    內部專用欄位，不對外開放使用。

    null
    PasswordStrategy

    object
    說明

    內部專用欄位，不對外開放使用。

    TenantPasswordLength

    string
    說明

    內部專用欄位，不對外開放使用。

    null
    TenantAlternativeChars

    array
    說明

    內部專用欄位，不對外開放使用。

    string
    說明

    內部專用欄位，不對外開放使用。

    null
    NickName

    string

    WyId

    string

    OfficeSiteId

    string

    OfficeSiteName

    string

    樣本

    正常返回樣本

    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"
    ]
  },
  "NickName": "",
  "WyId": "",
  "OfficeSiteId": "",
  "OfficeSiteName": ""
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。