LoginPasswordlessSmsOtp

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

LoginPasswordlessSmsOtp クラスは、login-passwordless-sms-otp 画面の機能を実装します。この画面では、ユーザーの電話番号と code を入力します。

​

コンストラクター

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

Example

import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp';
const loginPasswordlessSmsOtpManager = new LoginPasswordlessSmsOtp();
loginPasswordlessSmsOtpManager.submitOTP({
  code: '123456',
});

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnLoginPasswordlessSmsOtp

設定やコンテキストを含む、login-passwordless-sms-otp 画面固有の詳細を含みます。

tenant · TenantMembers

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

transaction · TransactionMembersOnLoginPasswordlessSmsOtp

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

untrustedData · UntrustedDataMembers

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

user · UserMembers

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

​

メソッド

changeLanguage · Promise<void>

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

Example

import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp';
const loginPasswordlessSmsOtpManager = new LoginPasswordlessSmsOtp();
loginPasswordlessSmsOtpManager.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 []

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

resendManager · ResendControl

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

Example

import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp';

const loginPasswordlessSmsOtpManager = new LoginPasswordlessSmsOtp();
const { startResend } = loginPasswordlessSmsOtpManager.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

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

resendOTP · Promise<void>

このメソッドは、ユーザーの電話番号に code を再送します。

Example

import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp';
const loginPasswordlessSmsOtpManager = new LoginPasswordlessSmsOtp();
loginPasswordlessSmsOtpManager.resendOTP();

メソッドのパラメーター

表示 パラメーター

options

CustomOptions。

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

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

submitOTP · Promise<void>

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

Example

import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp';
const loginPasswordlessSmsOtpManager = new LoginPasswordlessSmsOtp();
loginPasswordlessSmsOtpManager.submitOTP({
  code: '123456',
});

メソッドパラメーター

表示 パラメーター

options

SubmitOTPOptions。

code · string · 必須

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

captcha? · string

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

username? · string

ユーザーの識別子です。

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

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

switchConnection · Promise<void>

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

Example

import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp';
const loginPasswordlessSmsOtpManager = new LoginPasswordlessSmsOtp();
loginPasswordlessSmsOtpManager.switchConnection({
  connection: 'sms',
});

メソッドパラメーター

表示 パラメーター

options

SwitchConnectionOptionsSmsOtp。

connection · string · 必須

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

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

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