LoginPasswordlessEmailCode

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

LoginPasswordlessEmailCode クラスは、login-passwordless-email-code 画面の機能を実装します。この画面では、ユーザーのメールアドレスと 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

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

screen · ScreenMembersOnLoginPasswordlessEmailCode

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

tenant · TenantMembers

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

transaction · TransactionMembersOnLoginPasswordlessEmailCode

アクティブな識別子やフローの状態など、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' に設定すると、選択した言語はセッション中保持されます。

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

ulp- を接頭辞として持つ追加のカスタムフィールド (例: 'ulp-custom-field') 。

getErrors · Error []

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

resendCode · Promise<void>

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

Example

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

メソッドパラメーター

表示 パラメーター

options

CustomOptions。

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

ulp- を接頭辞として持つ追加のカスタムフィールド (例: 'ulp-custom-field') 。

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(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`);
  },
  onTimeout: () => {
    console.log('Resend is now available');
  }
});

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

メソッドパラメーター

表示 パラメーター

options

StartResendOptions。

timeoutSeconds? · number

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

onStatusChange? · OnStatusChangeCallback

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

onTimeout? · () => void

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

submitCode · Promise<void>

このメソッドは、メールアドレスに送信された code を使用してログイン処理を続行します。

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

ユーザーが入力した code です。

captcha? · string

キャプチャの code、またはキャプチャプロバイダーから返されたレスポンスです。Auth0 テナントで Bot Detection が有効になっている場合、このプロパティは必須です。

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

ulp- で始まる追加のカスタムフィールド (例: 'ulp-custom-field') 。

switchConnection · Promise<void>

このメソッドは、データベース接続 (パスワード) とパスワードレス接続 (メールアドレス/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' を使用し、パスワードベース認証には DB 接続名を使用します。

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

ulp- で始まる追加のカスタムフィールド (例: 'ulp-custom-field') 。