MfaSmsChallenge

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

mfa-sms-challenge 画面では、MFA 検証を完了するために、SMS で電話に送信されたワンタイムコードを入力するようユーザーに求めます。

​

インポート

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

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

Import Example

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

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

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

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

このフックは、MFAフローが Organization にスコープ設定されている場合に、ユーザーの組織に関する情報を提供します。組織コンテキストが存在しない場合は null を返します。

Example

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

useScreen · () => ScreenMembersOnMfaSmsChallenge

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

このフックは、現在の MFAフローの状態など、mfa-sms-challenge 画面に固有の transaction データを提供します。

Example

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

useUntrustedData · () => UntrustedDataMembersOnMfaSmsChallenge

このフックは、URLパラメーターから事前入力された値など、画面に渡される信頼されていないデータを扱います。

Example

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

useUser · () => UserMembers

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

Example

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

useMfaSmsChallenge · MfaSmsChallengeMembers

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

​

メソッド

continueMfaSmsChallenge · Promise<void>

このメソッドは、MFAチャレンジを完了するために、SMSで受け取ったワンタイムコードを送信します。

Example

import { useMfaSmsChallenge } from '@auth0/auth0-acul-react/mfa-sms-challenge';

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

メソッドのパラメータ

表示 パラメータ

options

MfaSmsChallengeOptions。

code · string · 必須

SMSでユーザーの電話番号に送信されたワンタイムコード。

rememberDevice · boolean

デバイスを記憶し、今後のログインでMFAを省略するかどうか。

getACall · Promise<void>

このメソッドは、MFAチャレンジをSMSではなく音声通話に切り替えます。

Example

import { useMfaSmsChallenge } from '@auth0/auth0-acul-react/mfa-sms-challenge';

function GetACallButton() {
  const { getACall } = useMfaSmsChallenge();
  return (
    <button onClick={() => getACall()}>
      Get a Call Instead
    </button>
  );
}

pickSms · Promise<void>

このメソッドは、SMSの電話番号選択画面に遷移します。

Example

import { useMfaSmsChallenge } from '@auth0/auth0-acul-react/mfa-sms-challenge';

function PickSmsButton() {
  const { pickSms } = useMfaSmsChallenge();
  return (
    <button onClick={() => pickSms()}>
      Use a Different Phone Number
    </button>
  );
}

resendCode · Promise<void>

このメソッドは、SMSのワンタイムコードをユーザーの電話番号に再送します。

Example

import { useMfaSmsChallenge } from '@auth0/auth0-acul-react/mfa-sms-challenge';

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

tryAnotherMethod · Promise<void>

このメソッドはMFA方式の選択画面に遷移し、ユーザーが別の認証要素を選べるようにします。

Example

import { useMfaSmsChallenge } from '@auth0/auth0-acul-react/mfa-sms-challenge';

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

​

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

useResend · Hooks

このフックは、コード再送機能のある画面で、再送のクールダウン状態とそのロジックを管理します。

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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