MfaOtpChallenge

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

MfaOtpChallenge クラスは、mfa-otp-challenge 画面の機能を実装します。この画面は、MFA でユーザーが OTP コードを入力する必要がある場合に表示されます。

​

コンストラクター

MFA OTP Challenge画面マネージャーのインスタンスを作成します。

Example

import MfaOtpChallenge from '@auth0/auth0-acul-js/mfa-otp-challenge';

const mfaOtpChallenge = new MfaOtpChallenge();
await mfaOtpChallenge.continue({
  code: '123456',
  rememberDevice: true
});

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

mfa-otp-challenge 画面の id、name、logoUrl など、クライアントに関する構成を提供します。

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnMfaOtpChallenge

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

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembersOnMfaOtpChallenge

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

user · UserMembers

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

​

メソッド

changeLanguage · Promise<void>

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

Example

import MfaOtpChallenge from '@auth0/auth0-acul-js/mfa-otp-challenge';
const mfaOtpChallenge = new MfaOtpChallenge();
mfaOtpChallenge.changeLanguage({
  language: 'fr',
});

メソッド パラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

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

continue · Promise<void>

このメソッドは、指定された code を使用して OTP チャレンジを続行します。

Example

import MfaOtpChallenge from '@auth0/auth0-acul-js/mfa-otp-challenge';

const mfaOtpChallenge = new MfaOtpChallenge();
await mfaOtpChallenge.continue({
  code: '123456',
  rememberDevice: true
});

メソッド パラメーター

表示 パラメーター

options

ContinueOTPOptions。

code · string · 必須

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

rememberDevice? · boolean

ブラウザーを記憶するかどうかを示します。

getErrors · Error []

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

tryAnotherMethod · Promise<void>

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

Example

import MfaOtpChallenge from '@auth0/auth0-acul-js/mfa-otp-challenge';

const mfaOtpChallenge = new MfaOtpChallenge();
await mfaOtpChallenge.tryAnotherMethod();