すべてのプロダクト
Search
ドキュメントセンター

:GetLoginToken

最終更新日:Feb 05, 2026

ログイントークンを取得します。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

必須

リージョン ID です。サポート対象のリージョン一覧を取得するには、DescribeRegions を呼び出します。

cn-hangzhou

ClientId

string

必須

クライアントによって生成された一意の ID です。

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

DirectoryId

string

任意

オフィスネットワーク ID です。このパラメーターは OfficeSiteId と同一です。代わりに OfficeSiteId を使用することを推奨します。DirectoryIdOfficeSiteId の両方を指定することはできません。

cn-hangzhou+dir-885351****

OfficeSiteId

string

任意

オフィスネットワーク ID です。

cn-hangzhou+dir-885351****

SessionId

string

任意

ログインセッション ID です。

  • 仮想多要素認証 (MFA) デバイスをバインドしていない場合、またはクライアントに対して二要素認証を有効化していない場合は、SessionId を指定しないでください。

  • 仮想 MFA デバイスがバインドされている場合、またはクライアントに対して二要素認証が有効化されている場合は、ADPassword ステージに続くログイン認証ステージで SessionId を指定します。簡便アカウント認証の場合、ADPassword ステージにおける GetLoginToken リクエスト応答から SessionId を取得してください。

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

CurrentStage

string

任意

現在のログイン認証ステージです。各ステージは順次実行されます。

  • ADPassword:ユーザー情報を検証します。簡便アカウントまたは Active Directory (AD) アカウントによるパスワード認証では、この値を指定します。

  • MFABind:仮想 MFA デバイスをバインドします。

  • MFAVerify:仮想 MFA デバイスが生成したセキュリティコードを検証します。

  • TokenVerify:クライアントに対して二要素認証を実行します。

  • ChangePassword:ユーザーのパスワードを変更します。

  • KeepAliveVerify:有効な KeepAliveToken を LoginToken と交換します。

ADPassword

EndUserId

string

任意

簡便ユーザまたは AD ユーザのユーザー名です。CurrentStageADPassword に設定した場合、このパラメーターは必須です。

alice

Password

string

任意

簡便ユーザまたは AD ユーザのパスワードです。CurrentStageADPassword に設定した場合、このパラメーターは必須です。

Password1234

OldPassword

string

任意

旧パスワードです。CurrentStageChangePassword に設定した場合、このパラメーターは必須です。

OldPassword

NewPassword

string

任意

新パスワードです。CurrentStageChangePassword に設定した場合、このパラメーターは必須です。

NewPassword

AuthenticationCode

string

任意

仮想 MFA デバイスが生成したセキュリティコードです。CurrentStageMFAVerify に設定した場合、このパラメーターは必須です。

47****

ClientOS

string

任意

クライアントを実行するデバイスのオペレーティングシステムです。

Windows_NT 10.0.18363 x64

ClientVersion

string

任意

クライアントのバージョンです。WUYING Workspace クライアントを使用している場合は、クライアントのログインインターフェイス上の [バージョン情報] ダイアログボックスで確認できます。

2.1.0-R-20210731.151756

TokenCode

string

任意

WUYING Workspace コンソールでクライアントの二要素認証を有効化し、現在のユーザーに対してログイン脅威が検出された場合、二要素認証用の検証コードがエンドユーザのメールアドレスに送信されます。CurrentStageTokenVerify に設定した場合、このパラメーターは必須です。

63****

KeepAlive

boolean

任意

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

列挙値:

  • null :

    ログイン状態を維持しません(デフォルト値)。

  • true :

    ログイン状態を維持します。

  • false :

    ログイン状態を維持しません。

false

KeepAliveToken

string

任意

ログイン状態を維持するために使用されるトークンです。ユーザーが正常にログインし、ログイン状態維持機能を有効化すると、API から KeepAliveToken が返されます。KeepAliveToken の有効期間内に、GetLoginToken 操作を呼び出し、CurrentStageKeepAliveVerify に設定して、KeepAliveToken をログイントークン (LoginToken) と交換します。CurrentStageKeepAliveVerify に設定した場合、このパラメーターは必須です。

hide

Uuid

string

任意

クライアントの一意の識別子です。WUYING Workspace クライアントを使用している場合は、クライアントのログインインターフェイス上の [バージョン情報] ダイアログボックスで確認できます。

C78CA9E99315687575DD2844C1F3****

ClientType

string

任意

WUYING Workspace ソフトウェアクライアントの種類です。

列挙値:

  • HTML5 :

    Web クライアント

  • WINDOWS :

    Windows クライアント

  • MACOS :

    macOS クライアント

  • IOS :

    iOS クライアント

  • ANDROID :

    Android クライアント

WINDOWS

AvailableFeatures

object

任意

string

任意

ClientName

string

任意

レスポンスフィールド

フィールド

説明

object

返される情報です。

Email

string

ユーザーのメールアドレスです。ログイン成功後に LoginToken とともに返されます。

  • 簡便ユーザの場合、これは簡便ユーザ作成時に設定されたメールアドレスです。

  • Active Directory (AD) ユーザの場合、フォーマットは username@AD domain name です。

alice

Secret

string

仮想 MFA デバイスをバインドするために使用されるキーです。このパラメーターは MFABind ステージで使用されます。

説明

認証ステージの詳細については、「CurrentStage リクエストパラメーター」の説明をご参照ください。

5OCLLKKOJU5HPBX66H3QCTWYI7MH****

RequestId

string

リクエスト ID です。

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

EndUserId

string

簡便アカウントまたは AD ユーザのユーザー名です。

alice

LoginToken

string

ログイントークンです。

v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****

NextStage

string

予期される次のステージです。たとえば、管理者が WUYING Workspace コンソールで MFA を有効化した場合、ユーザー名とパスワードの認証後(ADPassword ステージ後)にこのパラメーターは MFAVerify を返します。これは MFA の実行が必要であることを示します。

説明

認証ステージの詳細については、「CurrentStage リクエストパラメーター」の説明をご参照ください。

MFAVerify

QrCodePng

string

仮想 MFA デバイスをバインドするために使用されるキーの QR コードです。値は 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

Alibaba Cloud アカウント ID です。ハードウェアクライアントの識別に使用されます。

166353906220****

KeepAliveToken

string

ログイン状態を維持するために使用されるトークンです。ユーザーが正常にログインし、ログイン状態維持機能を有効化すると、API から 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

成功レスポンス

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

エラーコード

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

変更履歴

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