LoginEmailVerification

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

LoginEmailVerification クラスは、login-email-verification 画面の機能を提供します。この画面では、ログインプロセス中に本人確認を行うため、メールアドレスに送信されたワンタイムコードの入力をユーザーに求めます。

​

コンストラクター

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

Example

import LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification';
const loginEmailVerificationManager = new LoginEmailVerification();
loginEmailVerificationManager.continueWithCode({
  code: '123456',
});

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

login-email-verification 画面向けの、id、name、logoUrl などのクライアント関連の構成情報を提供します。

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembers

設定やコンテキストなど、login-email-verification 画面に固有の詳細を含みます。

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

ログイン時のユーザー入力など、SDK に渡される信頼できないデータを扱います。

user · UserMembers

username、email、roles などを含む、現在のユーザーの詳細です。

​

メソッド

changeLanguage · Promise<void>

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

Example

import LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification';
const loginEmailVerificationManager = new LoginEmailVerification();
loginEmailVerificationManager.changeLanguage({
  language: 'fr',
});

メソッド パラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

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

continueWithCode · Promise<void>

このメソッドは、ユーザーが入力したメール確認コードを送信します。

Example

import LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification';
const loginEmailVerificationManager = new LoginEmailVerification();
loginEmailVerificationManager.continueWithCode({
  code: '123456',
});

メソッド パラメーター

表示 パラメーター

options

ContinueWithCodeOptionPayload。

code · string · 必須

ユーザーのメールに送信された確認コード。

getErrors · Error []

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

resendCode · Promise<void>

このメソッドは、新しい確認コードをユーザーのメールアドレスに送信するよう要求します。

Example

import LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification';
const loginEmailVerificationManager = new LoginEmailVerification();
loginEmailVerificationManager.resendCode();

resendManager · ResendControl

このメソッドは、タイムアウト管理付きの再送機能を提供します。再送を開始する startResend() メソッドを持つ ResendControl オブジェクトを返し、ユーザーが再度再送できるようになるまでクールダウン期間を設けます。

Example

import LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification';

const loginEmailVerificationManager = new LoginEmailVerification();
const { startResend } = loginEmailVerificationManager.resendManager({
  timeoutSeconds: 15,
  onStatusChange: (remainingSeconds, isDisabled) => {
    console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`);
  },
  onTimeout: () => {
    console.log('Resend is now available');
  }
});

// ユーザーが再送ボタンをクリックしたときに startResend を呼び出します
startResend();

メソッド パラメーター

表示 パラメーター

options

StartResendOptions。

timeoutSeconds? · number

ユーザーがコードを再送できるようになるまでのクールダウン時間 (秒) 。

onStatusChange? · OnStatusChangeCallback

再送の状態が変化するたびに呼び出されるコールバックです。残り秒数と、再送機能が現在無効かどうかを返します。

onTimeout? · () => void

クールダウンが終了し、再送が再び可能になったときに呼び出されるコールバックです。