ResetPasswordMfaWebauthnRoamingChallenge

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

reset-password-mfa-webauthn-roaming-challenge 画面は、ローミング セキュリティキーによる多要素認証が必要な場合に、パスワードリセットフロー中に表示されます。この画面では、リセット処理を続行するために、外部ハードウェアのセキュリティキーを使用して認証するようユーザーに求めます。

​

インポート

各画面には、それぞれ固有のフックとメソッドのセットがあります。SDK は、各画面で部分インポートとルートインポートをサポートしています。

• 部分インポートを使用すると、特定のユースケースに必要なコードだけを含めることができます。
• ルートインポートを使用すると、単一のバンドルからすべての画面を読み込めます。これは、すべての画面に対応する統一されたビルドを用意したい場合に便利です。

Import Example

// ルートインポート
import { useResetPasswordMfaWebAuthnRoamingChallenge } from '@auth0/auth0-acul-react';

// 部分インポート
import {
  useResetPasswordMfaWebAuthnRoamingChallenge,
  // コンテキストフック
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // 共通フック
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // ユーティリティフック
  useChangeLanguage,
  // メソッド
  showError,
  tryAnotherMethod,
  useSecurityKey,
} from '@auth0/auth0-acul-react/reset-password-mfa-webauthn-roaming-challenge';

function ResetPasswordMfaWebAuthnRoamingChallengeScreen() {
  const { useSecurityKey } = useResetPasswordMfaWebAuthnRoamingChallenge();
  return (
    <button onClick={() => useSecurityKey()}>
      Authenticate with Security Key
    </button>
  );
}

​

コンテキストフック

reset-password-mfa-webauthn-roaming-challenge 画面で、Auth0 のコンテキストデータへの読み取り専用アクセスを提供する画面スコープのフックです。@auth0/auth0-acul-react/reset-password-mfa-webauthn-roaming-challenge からインポートします。

useBranding · () => BrandingMembers

このフックは、reset-password-mfa-webauthn-roaming-challenge 画面に表示されるロゴ、色、テーマ設定などのブランディング設定を提供します。

Example

import { useBranding } from '@auth0/auth0-acul-react/reset-password-mfa-webauthn-roaming-challenge';
function CustomTheme() {
  const branding = useBranding();
}

useClient · () => ClientMembers

このフックは、reset-password-mfa-webauthn-roaming-challenge 画面で使用される id、name、logoUrl などのクライアント関連の設定を提供します。

Example

import { useClient } from '@auth0/auth0-acul-react/reset-password-mfa-webauthn-roaming-challenge';
function AppInfo() {
  const client = useClient();
}

useOrganization · () => OrganizationMembers

このフックは、パスワードリセットが組織スコープの場合に、ユーザーの組織に関する情報を提供します。組織コンテキストが存在しない場合は null を返します。

Example

import { useOrganization } from '@auth0/auth0-acul-react/reset-password-mfa-webauthn-roaming-challenge';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No Organization context</p>;
  }
}

usePrompt · () => PromptMembers

このフックには、認証フロー内の現在のプロンプトに関するデータが含まれます。

Example

import { usePrompt } from '@auth0/auth0-acul-react/reset-password-mfa-webauthn-roaming-challenge';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembersOnResetPasswordMfaWebAuthnRoamingChallenge

このフックには、設定やコンテキストなど、reset-password-mfa-webauthn-roaming-challenge 画面固有の詳細が含まれます。

Example

import { useScreen } from '@auth0/auth0-acul-react/reset-password-mfa-webauthn-roaming-challenge';
function ScreenDebug() {
  const screen = useScreen();
}

useTenant · () => TenantMembers

このフックには、id や関連するメタデータなど、テナントに関するデータが含まれます。

Example

import { useTenant } from '@auth0/auth0-acul-react/reset-password-mfa-webauthn-roaming-challenge';
function TenantInfo() {
  const tenant = useTenant();
}

useTransaction · () => TransactionMembers

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

Example

import { useTransaction } from '@auth0/auth0-acul-react/reset-password-mfa-webauthn-roaming-challenge';
function TransactionInfo() {
  const transaction = useTransaction();
}

useUntrustedData · () => UntrustedDataMembers

このフックは、URL パラメーターから事前入力されたメールアドレスや username など、画面に渡される信頼できないデータを扱います。

Example

import { useUntrustedData } from '@auth0/auth0-acul-react/reset-password-mfa-webauthn-roaming-challenge';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

このフックでは、username、email、利用可能な認証方法など、現在のユーザーの詳細を取得できます。

Example

import { useUser } from '@auth0/auth0-acul-react/reset-password-mfa-webauthn-roaming-challenge';
function UserProfile() {
  const user = useUser();
}

useResetPasswordMfaWebAuthnRoamingChallenge · ResetPasswordMfaWebAuthnRoamingChallengeMembers

このフックは、reset-password-mfa-webauthn-roaming-challenge 画面で利用可能なすべてのメソッドとコンテキストを返します。

​

メソッド

showError · Promise<void>

このメソッドは、ユーザーのデバイスでセキュリティキーのチャレンジが失敗したときに、WebAuthn のブラウザーエラーを Auth0 に報告します。

Example

import { useResetPasswordMfaWebAuthnRoamingChallenge } from '@auth0/auth0-acul-react/reset-password-mfa-webauthn-roaming-challenge';

function HandleSecurityKeyError() {
  const { showError } = useResetPasswordMfaWebAuthnRoamingChallenge();
  return (
    <button onClick={() => showError({ error: { name: 'NotAllowedError', message: 'User cancelled' } })}>
      Report Error
    </button>
  );
}

メソッドパラメーター

表示 パラメーター

options

ResetPasswordMfaWebAuthnRoamingChallengeShowErrorOptions.

rememberDevice? · boolean

true で、かつ screen.showRememberDevice も true の場合、現在のブラウザーからの以後のログインでは MFA をスキップします。

error · WebAuthnErrorDetails · 必須

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

name · string · 必須

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

message · string · 必須

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

tryAnotherMethod · Promise<void>

このメソッドは、別の MFA方式 を選択する画面にユーザーを移動します。

Example

import { useResetPasswordMfaWebAuthnRoamingChallenge } from '@auth0/auth0-acul-react/reset-password-mfa-webauthn-roaming-challenge';

function TryAnotherMethodButton() {
  const { tryAnotherMethod } = useResetPasswordMfaWebAuthnRoamingChallenge();
  return (
    <button onClick={() => tryAnotherMethod()}>
      Try Another Method
    </button>
  );
}

メソッドパラメーター

表示 パラメーター

options

ResetPasswordMfaWebAuthnRoamingChallengeTryAnotherMethodOptions.

rememberDevice? · boolean

true で、かつ screen.showRememberDevice も true の場合、現在のブラウザーからの以後のログインでは MFA をスキップします。

useSecurityKey · Promise<void>

このメソッドは、パスワードリセットフローの MFA ステップを続行するために、ローミングセキュリティキーのチャレンジを開始します。

Example

import { useResetPasswordMfaWebAuthnRoamingChallenge } from '@auth0/auth0-acul-react/reset-password-mfa-webauthn-roaming-challenge';

function UseSecurityKeyButton() {
  const { useSecurityKey } = useResetPasswordMfaWebAuthnRoamingChallenge();
  return (
    <button onClick={() => useSecurityKey()}>
      Authenticate with Security Key
    </button>
  );
}

メソッドパラメーター

表示 パラメーター

options

ResetPasswordMfaWebAuthnRoamingChallengeUseSecurityKeyOptions.

rememberDevice? · boolean

true で、かつ screen.showRememberDevice も true の場合、現在のブラウザーからの以後のログインでは MFA をスキップします。

​

共通/ユーティリティ フック

useAuth0Themes · Hooks

このフックは、ブランディングコンテキストから、フラット化された設定を含む現在のテーマオプションを取得します。

useChangeLanguage · Hooks

このフックは、現在の ACUL 画面の表示言語を変更するための関数を返します。

useCurrentScreen · Hooks

このフックは、現在の画面のコンテキストと state を取得します。

useErrors · Hooks

このフックは、画面上のサーバーエラー、クライアントエラー、開発者エラーを読み取り、管理します。