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

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnMfaWebAuthnPlatformEnrollment

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

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

MFA WebAuthn platform enrollment 中のユーザー入力など、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 · 必須

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

persist? · "session"

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

getErrors · Error []

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

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();