MfaWebAuthnRoamingEnrollment

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

MfaWebAuthnRoamingEnrollment クラスは、mfa-webauthn-roaming-enrollment 画面の機能を提供します。この画面は、ユーザーが WebAuthn のローミング認証要素 (たとえばセキュリティキー) を登録する必要がある場合に表示されます。

​

コンストラクター

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

Example

import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment';

const mfaWebAuthnRoamingEnrollment = new MfaWebAuthnRoamingEnrollment();
await mfaWebAuthnRoamingEnrollment.enroll();

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnMfaWebAuthnRoamingEnrollment

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

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

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

user · UserMembers

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

​

メソッド

changeLanguage · Promise<void>

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

Example

import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment';

const mfaWebAuthnRoamingEnrollment = new MfaWebAuthnRoamingEnrollment();
mfaWebAuthnRoamingEnrollment.changeLanguage({
  language: 'fr',
});

メソッドのパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

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

persist? · "session"

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

enroll · Promise<void>

このメソッドは、WebAuthn 認証情報の作成を開始し、結果をサーバーに送信します。

Example

import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment';

const mfaWebAuthnRoamingEnrollment = new MfaWebAuthnRoamingEnrollment();
await mfaWebAuthnRoamingEnrollment.enroll();

getErrors · Error []

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

showError · Promise<void>

このメソッドは、WebAuthn のブラウザーエラーの詳細をサーバーに送信します。

Example

import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment';

const mfaWebAuthnRoamingEnrollment = new MfaWebAuthnRoamingEnrollment();
await mfaWebAuthnRoamingEnrollment.showError({
  error: { name: 'NotAllowedError', message: 'The operation was not allowed.' },
});

メソッドのパラメーター

表示 パラメーター

options

CustomOptions。

error · WebAuthnErrorDetails · 必須

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

name · string · 必須

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

message · string · 必須

何が問題だったのかを説明するエラーメッセージです。

tryAnotherMethod · Promise<void>

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

Example

import MfaWebAuthnRoamingEnrollment from '@auth0/auth0-acul-js/mfa-webauthn-roaming-enrollment';

const mfaWebAuthnRoamingEnrollment = new MfaWebAuthnRoamingEnrollment();
await mfaWebAuthnRoamingEnrollment.tryAnotherMethod();