すべてのプロダクト
Search

このプロダクト

    Elastic Desktop Service:GetLoginToken

    ドキュメントセンター

    Elastic Desktop Service:GetLoginToken

    最終更新日:Jun 11, 2026

    ログイン認証情報を取得します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    リージョン ID。 DescribeRegions を呼び出して、Elastic Desktop サービス (EDS) がサポートするリージョンのリストを取得できます。

    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 を指定する必要があります。SessionId は、簡便アカウント検証の応答 (つまり、GetLoginToken リクエストが ADPassword 段階にある場合) から取得できます。

    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

    任意

    クライアントのバージョン。Elastic Desktop サービス (EDS) クライアントを使用している場合、クライアントのログインページの About ダイアログボックスでこのパラメーターを確認できます。

    2.1.0-R-20210731.151756
    TokenCode

    string

    任意

    Elastic Desktop サービス (EDS) コンソールで二要素クライアント認証が有効になっており、現在のログインユーザーがリスクありと識別された場合、二要素認証の確認コードがエンドユーザーのメールアドレスに送信されます。CurrentStage が TokenVerify に設定されている場合、このパラメーターは必須です。

    63****
    KeepAlive

    boolean

    任意

    ユーザーのログイン状態を維持するかどうかを指定します。

    列挙値:

    • null :

      ログイン状態を維持しない [デフォルト]。

    • true :

      ログイン状態を維持する。

    • false :

      ログイン状態を維持しない。

    false
    KeepAliveToken

    string

    任意

    ユーザーのログイン状態を維持するために使用されるトークン。ログインが成功し、ログイン状態維持オプションが有効になっている場合、操作は KeepAliveToken を返します。KeepAliveToken の有効期間中に、CurrentStage を KeepAliveVerify に設定して GetLoginToken 操作を呼び出し、ログイン認証情報 (LoginToken) と交換できます。CurrentStage が KeepAliveVerify に設定されている場合、このパラメーターは必須です。

    hide
    Uuid

    string

    任意

    クライアントの一意の識別子。Elastic Desktop サービス (EDS) クライアントを使用している場合、クライアントのログインページの About ダイアログボックスでこのパラメーターを確認できます。

    C78CA9E99315687575DD2844C1F3****
    ClientType

    string

    任意

    Elastic Desktop サービス (EDS) ソフトウェアクライアントのタイプ。

    列挙値:

    • HTML5 :

      Web クライアント。

    • WINDOWS :

      Windows クライアント。

    • MACOS :

      macOS クライアント。

    • IOS :

      iOS クライアント。

    • ANDROID :

      Android クライアント。

    WINDOWS
    AvailableFeatures

    object

    任意

    string

    任意

    ClientName

    string

    任意

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    The collection of returned information.

    Email

    string

    The email address of the user. This parameter is returned with LoginToken after a successful logon.

    • For a convenience user, the email address specified when the convenience user was created is returned.

    • For an AD user, the email address is returned in the following format: username@AD domain name.

    alice
    Secret

    string

    The secret key used when a virtual MFA device is bound. This parameter is used in the MFABind stage.

    説明

    For more information about each authentication stage, see the description of the CurrentStage request parameter of this operation.

    5OCLLKKOJU5HPBX66H3QCTWYI7MH****
    RequestId

    string

    The request ID.

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

    string

    The username of the convenience account or AD user.

    alice
    LoginToken

    string

    The logon credential.

    v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
    NextStage

    string

    The expected next stage. For example, if the administrator has enabled MFA authentication in the Elastic Desktop Service (EDS) console, after the username and password authentication is passed (that is, after the ADPassword stage), this parameter returns MFAVerify, indicating that MFA authentication is required.

    説明

    For more information about each authentication stage, see the description of the CurrentStage request parameter of this operation.

    MFAVerify
    QrCodePng

    string

    The QR code of the secret key used when a virtual MFA device is bound. The value is encoded in Base64. This parameter can be empty and is used in the MFABind stage.

    説明

    For more information about each authentication stage, see the description of the CurrentStage request parameter of this operation.

    5OCLLKKOJU5HPBX66H3QCTWY******
    Label

    string

    The attribute of the convenience user. If the user is an AD user, an empty value is returned.

    test:wuying
    SessionId

    string

    The session ID. This parameter is returned only when GetLoginToken is called for the first time in the same session. When multiple authentications are required, this parameter must be passed in the subsequent stages.

    説明

    For more information about each authentication stage, see the description of the CurrentStage request parameter of this operation.

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

    string

    The mobile number of the convenience user. If the user is an AD user, an empty value is returned.

    1381111****
    TenantId

    integer

    The Alibaba Cloud account ID. Used for hardware terminal identification.

    166353906220****
    KeepAliveToken

    string

    The token used to keep the user logged on. After a successful logon and when the keep-logon option is enabled, the operation returns KeepAliveToken. If the keep-logon option is not enabled, an empty value is returned.

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

    string
    説明

    Internal-only field. Not open to external use.

    edu
    Props

    object
    説明

    Internal-only field. Not open to external use.

    string
    説明

    Internal-only field. Not open to external use.

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

    string
    説明

    Internal-only field. Not open to external use.

    mode
    RiskVerifyInfo

    object

    Information related to logon risk identification.

    Email

    string

    When identity verification is triggered, this email address is used for verification.

    user@example.com
    LastLockDuration

    integer

    The account lock time.

    1713749778
    Locked

    string

    Specifies whether the account is locked.

    列挙値:

    • true :

      Yes

    • false :

      No

    true
    Phone

    string

    When identity verification is triggered, this mobile phone number is used for verification.

    1381111****
    Reason

    string
    説明

    Internal-only field. Not open to external use.

    null
    PasswordStrategy

    object
    説明

    Internal-only field. Not open to external use.

    TenantPasswordLength

    string
    説明

    Internal-only field. Not open to external use.

    null
    TenantAlternativeChars

    array
    説明

    Internal-only field. Not open to external use.

    string
    説明

    Internal-only field. Not open to external use.

    null
    NickName

    string

    WyId

    string

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。