MfaSmsChallenge

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

MfaSmsChallenge クラスは、mfa-sms-challenge 画面の機能を提供します。この画面は、ユーザーが本人確認のために SMS のコードを入力する必要がある場合に表示されます。

​

コンストラクター

MFA SMS チャレンジ 画面マネージャーのインスタンスを作成します:

Example

import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';

const mfaSmsChallenge = new MfaSmsChallenge();
await mfaSmsChallenge.continueMfaSmsChallenge({
  code: '123456',
  rememberDevice: true,
});

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

mfa-sms-challenge 画面向けに、id、name、logoUrl などのクライアント関連の設定を提供します。

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnMfaSmsChallenge

設定やコンテキストなど、mfa-sms-challenge 画面に固有の詳細を含みます。

tenant · TenantMembers

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

transaction · TransactionMembers

mfa-sms-challenge 画面向けに、有効な識別子やフローの状態など、トランザクション 固有のデータを提供します。

untrustedData · UntrustedDataMembersOnMfaSmsChallenge

MFA の SMS チャレンジ中のユーザー入力など、SDK に渡される信頼できないデータを扱います。

user · UserMembers

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

​

メソッド

changeLanguage · Promise<void>

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

Example

import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';

const mfaSmsChallenge = new MfaSmsChallenge();
mfaSmsChallenge.changeLanguage({
  language: 'fr',
});

メソッドパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

使用する言語のロケールコード (たとえば、'en'、'fr'、'es') 。

persist? · "session"

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

continueMfaSmsChallenge · Promise<void>

このメソッドは、指定されたコードを使用して MFA SMS チャレンジを送信します。

Example

import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';

const mfaSmsChallenge = new MfaSmsChallenge();
await mfaSmsChallenge.continueMfaSmsChallenge({
  code: '123456',
  rememberDevice: true,
});

メソッドパラメーター

表示 パラメーター

options

MfaSmsChallengeOptions。

code · string · 必須

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

rememberDevice? · boolean

true に設定すると、このデバイスが信頼済みとして登録され、同じデバイスから今後ログインする際には MFA を求められなくなります。

getACall · Promise<void>

このメソッドは、確認方法を音声通話に切り替えます。

Example

import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';

const mfaSmsChallenge = new MfaSmsChallenge();
await mfaSmsChallenge.getACall();

getErrors · Error []

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

pickSms · Promise<void>

このメソッドは、ユーザーが別の SMS 番号を選択できる画面に移動します。

Example

import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';

const mfaSmsChallenge = new MfaSmsChallenge();
await mfaSmsChallenge.pickSms();

resendCode · Promise<void>

このメソッドは、SMS の確認コードをユーザーに再送します。

Example

import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';

const mfaSmsChallenge = new MfaSmsChallenge();
await mfaSmsChallenge.resendCode();

resendManager · ResendControl

このメソッドは、設定可能なタイムアウトとステータス管理を備えた再送機能を提供します。

Example

import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';

const mfaSmsChallenge = new MfaSmsChallenge();
const { startResend } = mfaSmsChallenge.resendManager({
  timeoutSeconds: 15,
  onStatusChange: (remainingSeconds, isDisabled) => {
    console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`);
  },
  onTimeout: () => {
    console.log('Resend is now available');
  },
});

startResend();

メソッドのパラメーター

表示 パラメーター

options

StartResendOptions。

onStatusChange? · OnStatusChangeCallback

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

onTimeout? · () => void

再送のタイムアウトが過ぎて、再送オプションが利用可能になったときに呼び出されるコールバックです。

timeoutSeconds? · number

再送オプションが利用可能になるまでの秒数です。

tryAnotherMethod · Promise<void>

このメソッドを使うと、ユーザーは別のMFA方式を試すことができます。

Example

import MfaSmsChallenge from '@auth0/auth0-acul-js/mfa-sms-challenge';

const mfaSmsChallenge = new MfaSmsChallenge();
await mfaSmsChallenge.tryAnotherMethod();