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

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

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 · 必須

使用する言語の locale コード (たとえば、'en'、'fr'、'es') 。

persist? · "session"

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

getErrors · Error []

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

showError · Promise<void>

このメソッドは、ユーザーによるキャンセル (NotAllowedError) や navigator.credentials.get() のタイムアウトなど、ブラウザー側の 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()) から返される error object。

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 (ユーザーによるキャンセルなど) をスローした場合は、エラーを catch して 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 を再度求められないようにします。