LoginPasswordlessSmsOtp

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

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

​

コンストラクター

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

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

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

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(`再送信は ${remainingSeconds}s 後に利用可能です。無効状態: ${isDisabled}`);
  },
  onTimeout: () => {
    console.log('再送信が利用可能になりました');
  }
});

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

メソッドのパラメータ

表示 パラメータ

options

StartResendOptions。

timeoutSeconds? · number

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

onStatusChange? · OnStatusChangeCallback

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

onTimeout? · () => void

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

resendOTP · Promise<void>

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

Example

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

submitOTP · Promise<void>

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

Example

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

メソッドのパラメータ

表示 パラメータ

options

SubmitOTPOptions。

code · string · 必須

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

captcha? · string

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

username? · string

ユーザーの識別子。

switchConnection · Promise<void>

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