LoginPasswordlessEmailCode

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

LoginPasswordlessEmailCode クラスは、login-passwordless-email-code 画面の機能を実装します。この画面では、ユーザーのメールアドレスとコードを入力します。

​

コンストラクター

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

Example

import LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code';
const loginPasswordlessEmailCodeManager = new LoginPasswordlessEmailCode();
loginPasswordlessEmailCodeManager.submitCode({
  code: '123456',
});

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

login-passwordless-email-code 画面で使用される id、name、logoUrl など、クライアント関連の構成を提供します。

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnLoginPasswordlessEmailCode

構成やコンテキストなど、login-passwordless-email-code 画面に固有の詳細が含まれます。

tenant · TenantMembers

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

transaction · TransactionMembersOnLoginPasswordlessEmailCode

有効な identifier やフローの state など、login-passwordless-email-code 画面におけるトランザクション固有のデータを提供します。

untrustedData · UntrustedDataMembers

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

user · UserMembers

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

​

メソッド

changeLanguage · Promise<void>

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

Example

import LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code';
const loginPasswordlessEmailCodeManager = new LoginPasswordlessEmailCode();
loginPasswordlessEmailCodeManager.changeLanguage({
  language: 'fr',
});

メソッドのパラメータ

表示 パラメータ

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

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

getErrors · Error []

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

resendCode · Promise<void>

このメソッドは、ユーザーのメールアドレスにコードを再送します。

Example

import LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code';
const loginPasswordlessEmailCodeManager = new LoginPasswordlessEmailCode();
loginPasswordlessEmailCodeManager.resendCode();

resendManager · ResendControl

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

Example

import LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code';

const loginPasswordlessEmailCodeManager = new LoginPasswordlessEmailCode();
const { startResend } = loginPasswordlessEmailCodeManager.resendManager({
  timeoutSeconds: 15,
  onStatusChange: (remainingSeconds, isDisabled) => {
    console.log(`再送信は${remainingSeconds}秒後に利用可能です。無効化: ${isDisabled}`);
  },
  onTimeout: () => {
    console.log('再送信が利用可能になりました');
  }
});

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

メソッドのパラメータ

表示 パラメータ

options

StartResendOptions。

timeoutSeconds? · number

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

onStatusChange? · OnStatusChangeCallback

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

onTimeout? · () => void

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

submitCode · Promise<void>

このメソッドは、メールコードを使用してログインプロセスを続行します。

Example

import LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code';
const loginPasswordlessEmailCodeManager = new LoginPasswordlessEmailCode();
loginPasswordlessEmailCodeManager.submitCode({
  code: '123456',
});

メソッドのパラメータ

表示 パラメータ

options

SubmitCodeOptions。

code · string | number · 必須

ユーザーが入力したコードです。

captcha? · string

CAPTCHA プロバイダーからの CAPTCHA コードまたは応答です。Auth0 テナントでボット検出が有効になっている場合、このプロパティは必須です。

switchConnection · Promise<void>

このメソッドは、データベース接続 (パスワード) とパスワードレス接続 (Email/SMS OTP) を切り替えます。

Example

import LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code';
const loginPasswordlessEmailCodeManager = new LoginPasswordlessEmailCode();
loginPasswordlessEmailCodeManager.switchConnection({
  connection: 'email',
});

メソッドのパラメータ

表示 パラメータ

options

SwitchConnectionOptionsEmailCode。

connection · string · 必須

切り替え先の接続名。パスワードレスには 'email' または 'sms' を使用し、パスワードベースの認証にはデータベース接続名を使用します。