ResetPasswordMfaVoiceChallenge

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

reset-password-mfa-voice-challenge 画面は、音声通話による多要素認証が必要な場合に、パスワードリセットフロー中に表示されます。ユーザーは、リセット処理を続行するために、電話に送信された確認コードを入力する必要があります。

​

インポート

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

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

Import Example

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

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

function ResetPasswordMfaVoiceChallengeScreen() {
  const { continueMethod } = useResetPasswordMfaVoiceChallenge();
  return (
    <button onClick={() => continueMethod({ code: '123456' })}>
      Verify Code
    </button>
  );
}

​

Context Hooks

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

このフックは、reset-password-mfa-voice-challenge 画面向けに、id、name、logoUrl などのクライアント関連の設定を提供します。

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembersOnResetPasswordMfaVoiceChallenge

このフックには、設定やコンテキストを含む、reset-password-mfa-voice-challenge 画面固有の詳細情報が含まれます。

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useResetPasswordMfaVoiceChallenge · ResetPasswordMfaVoiceChallengeMembers

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

​

メソッド

continueMethod · Promise<void>

このメソッドは、パスワードリセットフローでMFAステップを続行するために、音声の確認コードを送信します。

Example

import { useResetPasswordMfaVoiceChallenge } from '@auth0/auth0-acul-react/reset-password-mfa-voice-challenge';

function VerifyCodeForm() {
  const { continueMethod } = useResetPasswordMfaVoiceChallenge();
  return (
    <button onClick={() => continueMethod({ code: '123456' })}>
      Verify Code
    </button>
  );
}

メソッドパラメーター

表示 パラメーター

options

ResetPasswordMfaVoiceChallengeContinueOptions。

code · string · 必須

ユーザーが入力した音声の確認コード。

resendCode · Promise<void>

このメソッドは、ユーザーの電話番号に音声の確認コードを再送信します。

Example

import { useResetPasswordMfaVoiceChallenge } from '@auth0/auth0-acul-react/reset-password-mfa-voice-challenge';

function ResendCodeButton() {
  const { resendCode } = useResetPasswordMfaVoiceChallenge();
  return (
    <button onClick={() => resendCode()}>
      Resend Code
    </button>
  );
}

switchToSms · Promise<void>

このメソッドは、MFAの配信方法を音声通話からSMSに切り替えます。

Example

import { useResetPasswordMfaVoiceChallenge } from '@auth0/auth0-acul-react/reset-password-mfa-voice-challenge';

function SwitchToSmsButton() {
  const { switchToSms } = useResetPasswordMfaVoiceChallenge();
  return (
    <button onClick={() => switchToSms()}>
      Switch to SMS
    </button>
  );
}

tryAnotherMethod · Promise<void>

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

Example

import { useResetPasswordMfaVoiceChallenge } from '@auth0/auth0-acul-react/reset-password-mfa-voice-challenge';

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

​

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

useResend · Hooks

このフックは再送信のクールダウン状態を管理し、ユーザーが音声による確認コードを再送信できるかどうかを追跡します。

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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