MfaWebAuthnRoamingChallenge

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

MfaWebAuthnRoamingChallenge クラスは、mfa-webauthn-roaming-challenge 画面の機能を提供します。この画面は、セキュリティキーなどのローミング認証器を使用してユーザーが本人確認を行う必要がある場合に表示されます。

​

コンストラクター

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

Example

import MfaWebAuthnRoamingChallenge from '@auth0/auth0-acul-js/mfa-webauthn-roaming-challenge';

const mfaWebAuthnRoamingChallenge = new MfaWebAuthnRoamingChallenge();
await mfaWebAuthnRoamingChallenge.verify();

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnMfaWebAuthnRoamingChallenge

設定やコンテキストを含む、mfa-webauthn-roaming-challenge 画面に固有の詳細を含みます。

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

MFA の WebAuthn roaming challenge 中のユーザー入力など、SDK に渡される信頼できないデータを扱います。

user · UserMembers

username、email、roles など、現在のユーザーの詳細です。

​

メソッド

changeLanguage · Promise<void>

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

Example

import MfaWebAuthnRoamingChallenge from '@auth0/auth0-acul-js/mfa-webauthn-roaming-challenge';

const mfaWebAuthnRoamingChallenge = new MfaWebAuthnRoamingChallenge();
mfaWebAuthnRoamingChallenge.changeLanguage({
  language: 'fr',
});

メソッドのパラメーター

表示 パラメーター

options

LanguageChangeOptions.

language · string · 必須

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

persist? · "session"

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

getErrors · Error []

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

reportWebAuthnError · Promise<void>

このメソッドは、navigator.credentials.get() の実行中に発生した WebAuthn API のエラーを報告します。

Example

import MfaWebAuthnRoamingChallenge from '@auth0/auth0-acul-js/mfa-webauthn-roaming-challenge';

const mfaWebAuthnRoamingChallenge = new MfaWebAuthnRoamingChallenge();
await mfaWebAuthnRoamingChallenge.reportWebAuthnError({
  error: { name: 'NotAllowedError', message: 'The operation was not allowed.' },
});

メソッドのパラメーター

表示 パラメーター

options

MfaWebAuthnRoamingChallengeReportErrorOptions.

error · WebAuthnErrorDetails · 必須

報告する WebAuthn API (navigator.credentials.get()) のエラーオブジェクトです。

name · string · 必須

エラー名です (例: 'NotAllowedError') 。

message · string · 必須

問題の内容を示すエラーメッセージです。

tryAnotherMethod · Promise<void>

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

Example

import MfaWebAuthnRoamingChallenge from '@auth0/auth0-acul-js/mfa-webauthn-roaming-challenge';

const mfaWebAuthnRoamingChallenge = new MfaWebAuthnRoamingChallenge();
await mfaWebAuthnRoamingChallenge.tryAnotherMethod();

verify · Promise<void>

このメソッドは、セキュリティキーを使用して WebAuthnチャレンジを開始します。

Example

import MfaWebAuthnRoamingChallenge from '@auth0/auth0-acul-js/mfa-webauthn-roaming-challenge';

const mfaWebAuthnRoamingChallenge = new MfaWebAuthnRoamingChallenge();
await mfaWebAuthnRoamingChallenge.verify();

メソッドのパラメーター

表示 パラメーター

options

CustomOptions.

rememberDevice? · boolean

true の場合、今後の MFAチャレンジのためにブラウザーを記憶します。screen.showRememberDevice が true の場合にのみ適用されます。