MfaOtpEnrollmentQr

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

MfaOtpEnrollmentQr クラスは、mfa-otp-enrollment-qr 画面の機能を実装します。この画面には、MFA の登録時にユーザーが認証アプリでスキャンするための QR コードが表示されます。

​

コンストラクター

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

Example

import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr';

const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr();
await mfaOtpEnrollmentQr.toggleView();

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnMfaOtpEnrollmentQr

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

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

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

user · UserMembers

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

​

メソッド

changeLanguage · Promise<void>

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

Example

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

メソッド パラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

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

continue · Promise<void>

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

Example

import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr';

const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr();
await mfaOtpEnrollmentQr.continue({ code: '123456' });

メソッド パラメーター

表示 パラメーター

options

MfaOtpEnrollmentQrContinueOptions。

code · string · 必須

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

getErrors · Error []

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

toggleView · Promise<void>

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

Example

import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr';

const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr();
await mfaOtpEnrollmentQr.toggleView();

tryAnotherMethod · Promise<void>

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

Example

import MfaOtpEnrollmentQr from '@auth0/auth0-acul-js/mfa-otp-enrollment-qr';

const mfaOtpEnrollmentQr = new MfaOtpEnrollmentQr();
await mfaOtpEnrollmentQr.tryAnotherMethod();