DeviceCodeActivation

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

DeviceCodeActivation クラスは、device-code-activation 画面の機能を提供します。この画面は、ユーザーがデバイスを有効化するために、そのデバイスに表示されているコードを入力する必要がある場合に表示されます。

​

コンストラクター

DeviceCodeActivation画面マネージャーのインスタンスを作成します:

Example

import DeviceCodeActivation from '@auth0/auth0-acul-js/device-code-activation';
const deviceCodeActivationManager = new DeviceCodeActivation();
await deviceCodeActivationManager.continue({ code: 'ABCD-1234' });

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembers

構成やコンテキストを含む、device-code-activation 画面固有の詳細が含まれます。

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

デバイスコード有効化フロー中のユーザー入力など、SDK に渡される信頼できないデータを処理します。

user · UserMembers

username、email、roles など、現在アクティブなユーザーの詳細です。

​

メソッド

changeLanguage · Promise<void>

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

Example

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

メソッドのパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

使用する言語のロケールコードです (例: 'en'、'fr'、'es') 。

persist? · "session"

'session' に設定すると、選択した言語がセッション中維持されます。

continue · Promise<void>

このメソッドは、ユーザーが入力したデバイスコードを送信して、アクティベーションを完了します。

Example

import DeviceCodeActivation from '@auth0/auth0-acul-js/device-code-activation';
const deviceCodeActivationManager = new DeviceCodeActivation();
await deviceCodeActivationManager.continue({ code: 'ABCD-1234' });

メソッドのパラメーター

表示 パラメーター

options

DeviceCodeActivationContinueOptions。

code · string · 必須

ユーザーが入力したデバイスコードです。

getErrors · Error []

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