ResetPasswordMfaWebAuthnRoamingChallenge

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

ResetPasswordMfaWebAuthnRoamingChallenge クラスは、reset-password-mfa-webauthn-roaming-challenge 画面の機能を実装します。この画面では、パスワードリセットフロー中の MFA ステップの一環として、ローミングセキュリティキー (FIDO2 USB キーなど) を使用して本人確認を行うようユーザーに求めます。

​

コンストラクター

ResetPasswordMfaWebAuthnRoamingChallenge 画面マネージャーのインスタンスを作成します。

Example

import ResetPasswordMfaWebAuthnRoamingChallenge from '@auth0/auth0-acul-js/reset-password-mfa-webauthn-roaming-challenge';
const resetPasswordMfaWebAuthnRoamingChallengeManager = new ResetPasswordMfaWebAuthnRoamingChallenge();
try {
  await resetPasswordMfaWebAuthnRoamingChallengeManager.useSecurityKey({
    rememberDevice: true,
  });
} catch (error) {
  if (error instanceof DOMException) {
    await resetPasswordMfaWebAuthnRoamingChallengeManager.showError({
      error: { name: error.name, message: error.message },
    });
  }
}

​

プロパティ

branding · BrandingMembers

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

client · ClientMembers

reset-password-mfa-webauthn-roaming-challenge 画面に対して、id、name、logoUrl などのクライアント関連の構成を提供します。

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge

構成やコンテキストなど、reset-password-mfa-webauthn-roaming-challenge 画面に固有の詳細を含みます。

tenant · TenantMembers

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

transaction · TransactionMembers

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

untrustedData · UntrustedDataMembers

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

user · UserMembers

username、email、roles など、アクティブなユーザーの詳細を含みます。

​

メソッド

changeLanguage · Promise<void>

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

Example

import ResetPasswordMfaWebAuthnRoamingChallenge from '@auth0/auth0-acul-js/reset-password-mfa-webauthn-roaming-challenge';
const resetPasswordMfaWebAuthnRoamingChallengeManager = new ResetPasswordMfaWebAuthnRoamingChallenge();
resetPasswordMfaWebAuthnRoamingChallengeManager.changeLanguage({
  language: 'fr',
});

メソッドのパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

変更先の言語のロケールコードです (例: 'en'、'fr'、'es') 。

persist? · "session"

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

getErrors · Error []

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

showError · Promise<void>

このメソッドは、ユーザーによるキャンセル (NotAllowedError) や navigator.credentials.get() の timeout など、ブラウザー側の WebAuthn エラーを Auth0 に報告します。

Example

import ResetPasswordMfaWebAuthnRoamingChallenge from '@auth0/auth0-acul-js/reset-password-mfa-webauthn-roaming-challenge';
const resetPasswordMfaWebAuthnRoamingChallengeManager = new ResetPasswordMfaWebAuthnRoamingChallenge();
await resetPasswordMfaWebAuthnRoamingChallengeManager.showError({
  error: { name: error.name, message: error.message },
});

メソッドのパラメーター

表示 パラメーター

options

ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions。

error · WebAuthnErrorDetails · 必須

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

name · string · 必須

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

message · string · 必須

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

rememberDevice? · boolean

true の場合、エラー報告時にデバイス記憶の設定も保持されます。

tryAnotherMethod · Promise<void>

このメソッドを使用すると、ユーザーは別の MFA方式 を選択してチャレンジを完了できます。

Example

import ResetPasswordMfaWebAuthnRoamingChallenge from '@auth0/auth0-acul-js/reset-password-mfa-webauthn-roaming-challenge';
const resetPasswordMfaWebAuthnRoamingChallengeManager = new ResetPasswordMfaWebAuthnRoamingChallenge();
await resetPasswordMfaWebAuthnRoamingChallengeManager.tryAnotherMethod();

メソッドのパラメーター

表示 パラメーター

options

ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions。

rememberDevice? · boolean

true の場合、方式を切り替える際にもデバイス記憶の設定を保持します。

useSecurityKey · Promise<void>

このメソッドは、WebAuthn のセキュリティキー チャレンジを開始し、生成された認証情報を送信して、パスワードリセットフロー中の MFA ステップを完了します。ブラウザーが DOMException をスローした場合 (ユーザーによるキャンセルなど) は、エラーをキャッチして showError を呼び出し、Auth0 に通知してください。

Example

import ResetPasswordMfaWebAuthnRoamingChallenge from '@auth0/auth0-acul-js/reset-password-mfa-webauthn-roaming-challenge';
const resetPasswordMfaWebAuthnRoamingChallengeManager = new ResetPasswordMfaWebAuthnRoamingChallenge();
try {
  await resetPasswordMfaWebAuthnRoamingChallengeManager.useSecurityKey({
    rememberDevice: true,
  });
} catch (error) {
  if (error instanceof DOMException) {
    await resetPasswordMfaWebAuthnRoamingChallengeManager.showError({
      error: { name: error.name, message: error.message },
    });
  }
}

メソッドパラメーター

表示 パラメーター

options

ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions。

rememberDevice? · boolean

true の場合、このデバイスを信頼済みとしてマークするため、以後このデバイスではユーザーに MFA が再度求められなくなります。