MfaRecoveryCodeChallenge

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

MfaRecoveryCodeChallenge クラスは、mfa-recovery-code-challenge 画面の機能を実装します。この画面は、ユーザーがログインするためにリカバリーコードを入力する必要がある場合に表示されます。

​

コンストラクター

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

Example

import MfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/mfa-recovery-code-challenge';

const mfaRecoveryCodeChallenge = new MfaRecoveryCodeChallenge();
await mfaRecoveryCodeChallenge.continue({ code: 'YOUR_RECOVERY_CODE' });

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembers

構成やコンテキストなど、mfa-recovery-code-challenge 画面に固有の詳細が含まれます。

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

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

user · UserMembers

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

​

メソッド

changeLanguage · Promise<void>

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

Example

import MfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/mfa-recovery-code-challenge';

const mfaRecoveryCodeChallenge = new MfaRecoveryCodeChallenge();
mfaRecoveryCodeChallenge.changeLanguage({
  language: 'fr',
});

メソッドパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

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

continue · Promise<void>

このメソッドは、指定されたリカバリーコードを使用して続行します。

Example

import MfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/mfa-recovery-code-challenge';

const mfaRecoveryCodeChallenge = new MfaRecoveryCodeChallenge();
await mfaRecoveryCodeChallenge.continue({ code: 'YOUR_RECOVERY_CODE' });

メソッドパラメーター

表示 パラメーター

options

MfaRecoveryCodeChallengeContinueOptions。

code · string · 必須

ユーザーが入力したリカバリーコードです。

getErrors · Error []

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

tryAnotherMethod · Promise<void>

このメソッドは、ユーザーが別の MFA 認証方法を選択できる画面に移動します。

Example

import MfaRecoveryCodeChallenge from '@auth0/auth0-acul-js/mfa-recovery-code-challenge';

const mfaRecoveryCodeChallenge = new MfaRecoveryCodeChallenge();
await mfaRecoveryCodeChallenge.tryAnotherMethod();