ResetPasswordMfaSmsChallenge

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

reset-password-mfa-sms-challenge 画面は、SMS を使用した多要素認証が必要な場合に、パスワードリセットフロー中に表示されます。この画面では、パスワードリセットを続行するために、ユーザーの電話番号に送信された確認コードの入力を求めます。

​

インポート

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

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

Import Example

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

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

function ResetPasswordMfaSmsChallengeScreen() {
  const { continueMfaSmsChallenge } = useResetPasswordMfaSmsChallenge();
  return (
    <button onClick={() => continueMfaSmsChallenge({ code: '123456' })}>
      Verify Code
    </button>
  );
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

import { useOrganization } from '@auth0/auth0-acul-react/reset-password-mfa-sms-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-sms-challenge';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembersOnResetPasswordMfaSmsChallenge

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useResetPasswordMfaSmsChallenge · ResetPasswordMfaSmsChallengeMembers

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

​

メソッド

continueMfaSmsChallenge · Promise<void>

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

Example

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

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

メソッドのパラメーター

表示 パラメーター

options

ResetPasswordMfaSmsChallengeOptions。

code · string · 必須

ユーザーが入力した SMS の確認コードです。

getACall · Promise<void>

このメソッドは、SMS ではなく音声通話で確認コードを受け取るようリクエストします。

Example

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

function GetACallButton() {
  const { getACall } = useResetPasswordMfaSmsChallenge();
  return (
    <button onClick={() => getACall()}>
      Call Me Instead
    </button>
  );
}

resendCode · Promise<void>

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

Example

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

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

tryAnotherMethod · Promise<void>

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

Example

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

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

​

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

useResend · Hooks

このフックは再送のクールダウン状態を管理し、ユーザーが SMS コードを再送できるかどうかを判別します。

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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