MfaWebAuthnPlatformEnrollment

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

MfaWebAuthnPlatformEnrollment クラスは、mfa-webauthn-platform-enrollment 画面の機能を実装します。この画面は、ユーザーが Touch ID や Face ID などのプラットフォーム認証器を登録する必要がある場合に表示されます。

​

コンストラクタ

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

Example

import MfaWebAuthnPlatformEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-platform-enrollment';

const mfaWebAuthnPlatformEnrollment = new MfaWebAuthnPlatformEnrollment();
await mfaWebAuthnPlatformEnrollment.submitPasskeyCredential();

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnMfaWebAuthnPlatformEnrollment

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

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

MFA WebAuthn プラットフォーム登録時のユーザー入力など、SDK に渡される未検証データを扱います。

user · UserMembers

username、email、roles など、現在アクティブなユーザーの詳細です。

​

メソッド

changeLanguage · Promise<void>

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

Example

import MfaWebAuthnPlatformEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-platform-enrollment';

const mfaWebAuthnPlatformEnrollment = new MfaWebAuthnPlatformEnrollment();
mfaWebAuthnPlatformEnrollment.changeLanguage({
  language: 'fr',
});

メソッドパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

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

getErrors · Error []

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

refuseEnrollmentOnThisDevice · Promise<void>

このメソッドを使用すると、ユーザーは現在のデバイスでの WebAuthn プラットフォーム登録を拒否できます。

Example

import MfaWebAuthnPlatformEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-platform-enrollment';

const mfaWebAuthnPlatformEnrollment = new MfaWebAuthnPlatformEnrollment();
await mfaWebAuthnPlatformEnrollment.refuseEnrollmentOnThisDevice();

reportBrowserError · Promise<void>

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

Example

import MfaWebAuthnPlatformEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-platform-enrollment';

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

メソッドパラメーター

表示 パラメーター

options

CustomOptions。

error · WebAuthnErrorDetails · 必須

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

name · string · 必須

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

message · string · 必須

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

snoozeEnrollment · Promise<void>

このメソッドを使用すると、ユーザーは WebAuthn プラットフォーム登録を延期できます。

Example

import MfaWebAuthnPlatformEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-platform-enrollment';

const mfaWebAuthnPlatformEnrollment = new MfaWebAuthnPlatformEnrollment();
await mfaWebAuthnPlatformEnrollment.snoozeEnrollment();

submitPasskeyCredential · Promise<void>

このメソッドは、WebAuthn プラットフォーム認証情報の作成を開始し、生成された認証情報をサーバーに送信します。

Example

import MfaWebAuthnPlatformEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-platform-enrollment';

const mfaWebAuthnPlatformEnrollment = new MfaWebAuthnPlatformEnrollment();
await mfaWebAuthnPlatformEnrollment.submitPasskeyCredential();