PhoneIdentifierChallenge

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

phone-identifier-challenge 画面は、ユーザーがワンタイムコードを入力して電話番号を確認する必要がある場合に表示されます。この画面では、コードを送信したり、再送したり、SMS 配信と音声配信を切り替えたり、前のステップに戻ったりできます。

​

インポート

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

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

Import Example

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

// 部分インポート
import {
  usePhoneIdentifierChallenge,
  // コンテキストフック
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // 共通フック
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  useResend,
  // ユーティリティフック
  useChangeLanguage,
  // メソッド
  submitPhoneChallenge,
  resendCode,
  returnToPrevious,
  switchToText,
  switchToVoice,
  switchToPassword,
} from '@auth0/auth0-acul-react/phone-identifier-challenge';

function PhoneIdentifierChallengeScreen() {
  const { submitPhoneChallenge } = usePhoneIdentifierChallenge();
  return (
    <button onClick={() => submitPhoneChallenge({ code: '123456' })}>Verify</button>
  );
}

​

Context Hooks

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

このフックは、phone-identifier-challenge 画面用の id、name、logoUrl など、クライアント関連の構成を提供します。

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

useScreen · () => ScreenMembersOnPhoneIdentifierChallenge

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

usePhoneIdentifierChallenge · PhoneIdentifierChallengeMembers

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

​

メソッド

submitPhoneChallenge · Promise<void>

このメソッドは、ユーザーが入力したワンタイムコードを送信して電話番号を確認し、認証フローを続行します。

Example

import { usePhoneIdentifierChallenge } from '@auth0/auth0-acul-react/phone-identifier-challenge';

function VerifyButton() {
  const { submitPhoneChallenge } = usePhoneIdentifierChallenge();
  return (
    <button onClick={() => submitPhoneChallenge({ code: '123456' })}>
      確認
    </button>
  );
}

メソッドのパラメーター

表示 パラメーター

options

PhoneChallengeOptions。

code · string · 必須

ユーザーの電話番号に送信された確認コード。

captcha? · string

このテナントで CAPTCHA が有効になっている場合に使用する、CAPTCHA 応答トークン。

resendCode · Promise<void>

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

Example

import { usePhoneIdentifierChallenge } from '@auth0/auth0-acul-react/phone-identifier-challenge';

function ResendButton() {
  const { resendCode } = usePhoneIdentifierChallenge();
  return (
    <button onClick={() => resendCode()}>
      コードを再送
    </button>
  );
}

returnToPrevious · Promise<void>

このメソッドは、ユーザーを認証フロー内の前のステップに戻します。

Example

import { usePhoneIdentifierChallenge } from '@auth0/auth0-acul-react/phone-identifier-challenge';

function BackButton() {
  const { returnToPrevious } = usePhoneIdentifierChallenge();
  return (
    <button onClick={() => returnToPrevious()}>
      戻る
    </button>
  );
}

switchToText · Promise<void>

このメソッドは、電話確認の送信方法を SMS テキストメッセージに切り替えます。

Example

import { usePhoneIdentifierChallenge } from '@auth0/auth0-acul-react/phone-identifier-challenge';

function SwitchToSmsButton() {
  const { switchToText } = usePhoneIdentifierChallenge();
  return (
    <button onClick={() => switchToText()}>
      SMSで送信
    </button>
  );
}

switchToVoice · Promise<void>

このメソッドは、電話確認の送信方法を音声通話に切り替えます。

Example

import { usePhoneIdentifierChallenge } from '@auth0/auth0-acul-react/phone-identifier-challenge';

function SwitchToVoiceButton() {
  const { switchToVoice } = usePhoneIdentifierChallenge();
  return (
    <button onClick={() => switchToVoice()}>
      音声通話で送信
    </button>
  );
}

switchToPassword · Promise<void>

このメソッドは、認証フローを電話 OTP による確認からパスワードベースの認証に切り替えます。

Example

import { usePhoneIdentifierChallenge } from '@auth0/auth0-acul-react/phone-identifier-challenge';

function SwitchToPasswordButton() {
  const { switchToPassword } = usePhoneIdentifierChallenge();
  return (
    <button onClick={() => switchToPassword()}>
      代わりにパスワードを使用
    </button>
  );
}

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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

useResend · Hooks

このフックは、resendCode メソッドの再送信クールダウン状態とタイマーを管理します。