ResetPasswordMfaSmsChallenge

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

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

​

インポート

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

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

Import Example

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

// 部分インポート
import {
  useResetPasswordMfaSmsChallenge,
  // コンテキストHooks
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // 共通Hooks
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  useResend,
  // ユーティリティHooks
  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>
  );
}

​

Context Hooks

reset-password-mfa-sms-challenge 画面で Auth0 のコンテキストデータへの読み取り専用アクセスを提供する、画面スコープの Hooks です。@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>組織コンテキストがありません</p>;
  }
}

usePrompt · () => PromptMembers

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

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 や関連するメタデータなど、tenant に関するデータが含まれます。

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 画面における transaction 固有のデータを提供します。

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>
  );
}

​

共通/ユーティリティ Hooks

useResend · Hooks

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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