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

ブランディングテーマや設定など、branding に関連する構成を提供します。

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

認証フロー内の現在の prompt に関するデータを含みます。

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 []

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