DeviceCodeConfirmation

Universal Login の device-code-confirmation 画面をカスタマイズするために利用できる、すべてのプロパティとメソッドについて説明します。

DeviceCodeConfirmation クラスは、device-code-confirmation 画面の機能を実装します。この画面は、ユーザーがデバイスコードの有効化を確認またはキャンセルする必要がある場合に表示されます。

​

コンストラクター

DeviceCodeConfirmation 画面マネージャーのインスタンスを生成します。

Example

import DeviceCodeConfirmation from '@auth0/auth0-acul-js/device-code-confirmation';
const deviceCodeConfirmationManager = new DeviceCodeConfirmation();
await deviceCodeConfirmationManager.confirm();

​

プロパティ

branding · BrandingMembers

ブランディングテーマや各種設定など、ブランディング関連の設定を提供します。

client · ClientMembers

device-code-confirmation 画面の id、name、logoUrl など、クライアント関連の設定を提供します。

organization · OrganizationMembers

id や name など、ユーザーの組織に関する情報を提供します。

prompt · PromptMembers

認証フローにおける現在のプロンプトに関するデータが含まれます。

screen · ScreenMembersOnDeviceCodeConfirmation

設定やコンテキストなど、device-code-confirmation 画面固有の詳細が含まれます。

tenant · TenantMembers

id や関連するメタデータなど、テナントに関するデータが含まれます。

transaction · TransactionMembers

アクティブな識別子やフローの状態など、device-code-confirmation 画面のトランザクション固有のデータを提供します。

untrustedData · UntrustedDataMembers

デバイスコード確認フロー中のユーザー入力など、SDK に渡される信頼できないデータを扱います。

user · UserMembers

username、email、roles など、アクティブなユーザーの詳細が含まれます。

​

メソッド

cancel · Promise<void>

このメソッドは、デバイスコードのアクティベーションフローをキャンセルします。

Example

import DeviceCodeConfirmation from '@auth0/auth0-acul-js/device-code-confirmation';
const deviceCodeConfirmationManager = new DeviceCodeConfirmation();
await deviceCodeConfirmationManager.cancel();

changeLanguage · Promise<void>

このメソッドは、Universal Login ページの表示言語を変更します。

Example

import DeviceCodeConfirmation from '@auth0/auth0-acul-js/device-code-confirmation';
const deviceCodeConfirmationManager = new DeviceCodeConfirmation();
deviceCodeConfirmationManager.changeLanguage({
  language: 'fr',
});

メソッドパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

変更先の言語のロケールコードです (例: 'en'、'fr'、'es') 。

persist? · "session"

'session' に設定すると、選択した言語はセッションの間保持されます。

confirm · Promise<void>

このメソッドは、デバイスコードを確認し、アクティベーションを続行します。

Example

import DeviceCodeConfirmation from '@auth0/auth0-acul-js/device-code-confirmation';
const deviceCodeConfirmationManager = new DeviceCodeConfirmation();
await deviceCodeConfirmationManager.confirm();

getErrors · Error []

このメソッドは、コンテキストからトランザクションエラーの配列を取得します。エラーがない場合は空の配列を返します。