MfaVoiceChallenge

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

mfa-voice-challenge 画面では、MFA 検証を完了するために、音声通話で届いたワンタイムコードの入力をユーザーに求めます。

​

インポート

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

• 部分インポートを使うと、特定の用途に必要なコードだけを取り込めます。
• ルートインポートを使うと、1 つのバンドルからすべての画面を読み込めるため、考えられるすべての画面に対応する統一されたビルドにしたい場合に便利です。

Import Example

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

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

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

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

useScreen · () => ScreenMembersOnMfaVoiceChallenge

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

このフックは、現在の MFA フローの state など、mfa-voice-challenge 画面におけるトランザクション固有のデータを提供します。

Example

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

useUntrustedData · () => UntrustedDataMembersOnMfaVoiceChallenge

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

Example

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

useUser · () => UserMembers

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

Example

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

useMfaVoiceChallenge · MfaVoiceChallengeMembers

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

​

メソッド

continueMethod · Promise<void>

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

Example

import { useMfaVoiceChallenge } from '@auth0/auth0-acul-react/mfa-voice-challenge';

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

メソッドのパラメーター

表示 パラメーター

options

MfaVoiceChallengeContinueOptions.

code · string · 必須

音声通話で受け取った確認コード。

rememberDevice · boolean

デバイスを30日間記憶し、今後のMFAチャレンジを省略するための省略可能なフラグ。

pickPhone · Promise<void>

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

Example

import { useMfaVoiceChallenge } from '@auth0/auth0-acul-react/mfa-voice-challenge';

function PickPhoneButton() {
  const { pickPhone } = useMfaVoiceChallenge();
  return (
    <button onClick={() => pickPhone()}>
      Use a Different Phone Number
    </button>
  );
}

resendCode · Promise<void>

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

Example

import { useMfaVoiceChallenge } from '@auth0/auth0-acul-react/mfa-voice-challenge';

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

switchToSms · Promise<void>

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

Example

import { useMfaVoiceChallenge } from '@auth0/auth0-acul-react/mfa-voice-challenge';

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

tryAnotherMethod · Promise<void>

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

Example

import { useMfaVoiceChallenge } from '@auth0/auth0-acul-react/mfa-voice-challenge';

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

​

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

useResend · Hooks

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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