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

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

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' に設定すると、選択した言語はセッションの間保持されます。

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

ulp- プレフィックスが付いた追加のカスタムフィールドです (例: 'ulp-custom-field') 。

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 · 必須

ユーザーのメールアドレスに送信された確認コードです。

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

ulp- プレフィックスが付いた追加のカスタムフィールドです (例: 'ulp-custom-field') 。

getErrors · Error []

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

resendCode · Promise<void>

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

Example

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

メソッドパラメーター

表示 パラメーター

options

CustomOptions。

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

ulp- プレフィックスが付いた追加のカスタムフィールドです (例: 'ulp-custom-field') 。

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

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

onStatusChange? · OnStatusChangeCallback

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

onTimeout? · () => void

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