MfaWebAuthnPlatformChallenge

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

MfaWebAuthnPlatformChallenge クラスは、mfa-webauthn-platform-challenge 画面の機能を提供します。この画面は、ユーザーが Touch ID や Face ID などのプラットフォーム認証器を使用して本人確認を行う必要がある場合に表示されます。

​

コンストラクター

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

Example

import MfaWebAuthnPlatformChallenge from '@auth0/auth0-acul-js/mfa-webauthn-platform-challenge';

const mfaWebAuthnPlatformChallenge = new MfaWebAuthnPlatformChallenge();
await mfaWebAuthnPlatformChallenge.verify();

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnMfaWebAuthnPlatformChallenge

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

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

MFA WebAuthn プラットフォーム チャレンジ中のユーザー入力など、SDK に渡される信頼できないデータを扱います。

user · UserMembers

現在アクティブなユーザーの詳細 (username、email、roles を含む) です。

​

メソッド

changeLanguage · Promise<void>

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

Example

import MfaWebAuthnPlatformChallenge from '@auth0/auth0-acul-js/mfa-webauthn-platform-challenge';

const mfaWebAuthnPlatformChallenge = new MfaWebAuthnPlatformChallenge();
mfaWebAuthnPlatformChallenge.changeLanguage({
  language: 'fr',
});

メソッドパラメータ

表示 パラメータ

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

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

getErrors · Error []

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

reportBrowserError · Promise<void>

このメソッドは、WebAuthn の navigator.credentials.get() 操作中に発生したブラウザー側エラーを報告します。

Example

import MfaWebAuthnPlatformChallenge from '@auth0/auth0-acul-js/mfa-webauthn-platform-challenge';

const mfaWebAuthnPlatformChallenge = new MfaWebAuthnPlatformChallenge();
await mfaWebAuthnPlatformChallenge.reportBrowserError({
  error: { name: 'NotAllowedError', message: 'The operation was not allowed.' },
});

メソッドパラメータ

表示 パラメータ

options

MfaWebAuthnPlatformChallengeReportErrorOptions。

error · WebAuthnErrorDetails · 必須

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

name · string · 必須

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

message · string · 必須

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

tryAnotherMethod · Promise<void>

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

Example

import MfaWebAuthnPlatformChallenge from '@auth0/auth0-acul-js/mfa-webauthn-platform-challenge';

const mfaWebAuthnPlatformChallenge = new MfaWebAuthnPlatformChallenge();
await mfaWebAuthnPlatformChallenge.tryAnotherMethod();

verify · Promise<void>

このメソッドは、WebAuthn プラットフォーム認証器チャレンジを開始します。

Example

import MfaWebAuthnPlatformChallenge from '@auth0/auth0-acul-js/mfa-webauthn-platform-challenge';

const mfaWebAuthnPlatformChallenge = new MfaWebAuthnPlatformChallenge();
await mfaWebAuthnPlatformChallenge.verify();

メソッドパラメータ

表示 パラメータ

options

CustomOptions。

rememberDevice? · boolean

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