全部產品
Search

搜尋本產品

    ：GetLoginToken - 擷取登入憑證

    文件中心

    ：GetLoginToken - 擷取登入憑證

    更新時間：Feb 05, 2026

    擷取登入憑證。

    調試

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

    調試

    授權資訊

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

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    RegionId

    string

    是

    地區 ID。可以調用 DescribeRegions 擷取無影雲電腦支援的地區列表。

    cn-hangzhou
    ClientId

    string

    是

    用戶端產生的唯一 ID。

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

    string

    否

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

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

    string

    否

    辦公網路識別碼。

    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 :

      網頁用戶端

    • 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 裝置時的密鑰二維碼。使用 Base 64 編碼。可以為空白，用於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

    樣本

    正常返回樣本

    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": ""
}

    錯誤碼

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

    變更歷史

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