MfaOtpEnrollmentCode

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

MfaOtpEnrollmentCode クラスは、mfa-otp-enrollment-code 画面の機能を実装します。この画面は、ユーザーが MFA 登録時に受け取った OTP コードを入力する必要がある場合に表示されます。

​

コンストラクター

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

Example

import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code';

const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode();
await mfaOtpEnrollmentCode.continue({
  code: '123456',
});

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnMfaOtpEnrollmentCode

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

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

MFA OTP の登録時のユーザー入力など、SDK に渡される信頼できないデータを処理します。

user · UserMembers

username、email、roles など、アクティブなユーザーの詳細を含みます。

​

メソッド

changeLanguage · Promise<void>

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

Example

import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code';
const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode();
mfaOtpEnrollmentCode.changeLanguage({
  language: 'fr',
});

メソッドパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

変更先の言語のロケールコードです (例: 'en'、'fr'、'es') 。

persist? · "session"

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

continue · Promise<void>

このメソッドは、OTP コードを送信して MFA OTP の登録プロセスを続行します。

Example

import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code';

const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode();
await mfaOtpEnrollmentCode.continue({
  code: '123456',
});

メソッドパラメーター

表示 パラメーター

options

MfaOtpContinueOptions。

code · string · 必須

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

getErrors · Error []

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

toggleView · Promise<void>

このメソッドは、QR コード表示と手動入力表示を切り替えます。

Example

import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code';

const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode();
await mfaOtpEnrollmentCode.toggleView();

tryAnotherMethod · Promise<void>

このメソッドでは、ユーザーが別の MFA 方法を試せます。

Example

import MfaOtpEnrollmentCode from '@auth0/auth0-acul-js/mfa-otp-enrollment-code';

const mfaOtpEnrollmentCode = new MfaOtpEnrollmentCode();
await mfaOtpEnrollmentCode.tryAnotherMethod();