MfaRecoveryCodeEnrollment

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

MfaRecoveryCodeEnrollment クラスは、mfa-recovery-code-enrollment 画面の機能を提供します。この画面は、ユーザーが MFA 用にリカバリーコードを登録する必要がある場合に表示されます。

​

コンストラクター

MFA リカバリーコード登録画面マネージャーのインスタンスを作成します:

Example

import MfaRecoveryCodeEnrollment from '@auth0/auth0-acul-js/mfa-recovery-code-enrollment';

const mfaRecoveryCodeEnrollment = new MfaRecoveryCodeEnrollment();
await mfaRecoveryCodeEnrollment.continue({ isCodeCopied: true });

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnMfaRecoveryCodeEnrollment

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

tenant · TenantMembers

id や関連するメタデータなど、tenant に関するデータを含みます。

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

MFA リカバリーコードの登録時のユーザー入力など、SDK に渡される信頼できないデータを扱います。

user · UserMembers

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

​

メソッド

changeLanguage · Promise<void>

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

Example

import MfaRecoveryCodeEnrollment from '@auth0/auth0-acul-js/mfa-recovery-code-enrollment';

const mfaRecoveryCodeEnrollment = new MfaRecoveryCodeEnrollment();
mfaRecoveryCodeEnrollment.changeLanguage({
  language: 'fr',
});

メソッドのパラメータ

表示 パラメータ

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

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

continue · Promise<void>

このメソッドは、ユーザーがリカバリーコードを保存したことを示し、登録フローを続行します。

Example

import MfaRecoveryCodeEnrollment from '@auth0/auth0-acul-js/mfa-recovery-code-enrollment';

const mfaRecoveryCodeEnrollment = new MfaRecoveryCodeEnrollment();
await mfaRecoveryCodeEnrollment.continue({ isCodeCopied: true });

メソッドのパラメータ

表示 パラメータ

options

MfaRecoveryCodeEnrollmentContinueOptions。

isCodeCopied? · boolean

ユーザーがリカバリーコードをコピーしたかどうかを示します。

getErrors · Error []

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