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

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

screen · ScreenMembersOnMfaWebAuthnPlatformChallenge

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

tenant · TenantMembers

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

transaction · TransactionMembers

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

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 の場合にのみ適用されます。