LoginPasswordlessSmsOtp

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

login-passwordless-sms-otp 画面では、パスワードレス SMS 認証を完了するために、ユーザーは電話番号に送信された ワンタイムパスワード を入力します。

​

インポート

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

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

Import Example

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

// 部分インポート
import {
  useLoginPasswordlessSmsOtp,
  // コンテキストフック
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // 共通フック
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // ユーティリティフック
  useChangeLanguage,
  useResend,
  // メソッド
  submitOTP,
  resendOTP,
  switchConnection,
} from '@auth0/auth0-acul-react/login-passwordless-sms-otp';

function SmsOtpForm() {
  const { submitOTP } = useLoginPasswordlessSmsOtp();
  return (
    <button onClick={() => submitOTP({ code: '123456' })}>
      Verify Code
    </button>
  );
}

​

Context Hooks

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

import { useOrganization } from '@auth0/auth0-acul-react/login-passwordless-sms-otp';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No organization context</p>;
  }
}

usePrompt · () => PromptMembers

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

Example

import { usePrompt } from '@auth0/auth0-acul-react/login-passwordless-sms-otp';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembersOnLoginPasswordlessSmsOtp

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembersOnLoginPasswordlessSmsOtp

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useLoginPasswordlessSmsOtp · LoginPasswordlessSmsOtpMembers

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

​

メソッド

resendOTP · Promise<void>

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

Example

import { useLoginPasswordlessSmsOtp } from '@auth0/auth0-acul-react/login-passwordless-sms-otp';

function ResendButton() {
  const { resendOTP } = useLoginPasswordlessSmsOtp();
  return (
    <button onClick={() => resendOTP()}>
      Resend Code
    </button>
  );
}

メソッドパラメーター

表示 パラメーター

options

CustomOptions。

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

ulp- プレフィックス付きの追加のカスタムフィールド (例: 'ulp-custom-field') 。

submitOTP · Promise<void>

このメソッドは、ワンタイムパスワードを送信してパスワードレス SMS 認証を完了します。

Example

import { useLoginPasswordlessSmsOtp } from '@auth0/auth0-acul-react/login-passwordless-sms-otp';

function SmsOtpForm() {
  const { submitOTP } = useLoginPasswordlessSmsOtp();
  return (
    <button onClick={() => submitOTP({ code: '123456' })}>
      Verify Code
    </button>
  );
}

メソッドパラメーター

表示 パラメーター

options

SubmitOTPOptions。

code · string · 必須

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

username? · string

フローで必要な場合に指定する、ユーザーの電話番号または識別子。

captcha? · string

テナントでボット検出が有効になっている場合に必要なキャプチャの値。

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

ulp- プレフィックス付きの追加のカスタムフィールド (例: 'ulp-custom-field') 。

switchConnection · Promise<void>

このメソッドは、フローを最初からやり直さずに別の認証接続へ切り替えます。

Example

import { useLoginPasswordlessSmsOtp } from '@auth0/auth0-acul-react/login-passwordless-sms-otp';

function ConnectionSwitcher() {
  const { switchConnection } = useLoginPasswordlessSmsOtp();
  return (
    <button onClick={() => switchConnection({ connection: 'enterprise-saml' })}>
      Use SSO
    </button>
  );
}

メソッドパラメーター

表示 パラメーター

options

SwitchConnectionOptionsSmsOtp。

connection · string · 必須

切り替え先の接続名。パスワードレスには ‘email’ または ‘sms’ を使用し、パスワードベースの認証には DB 接続名を使用します。

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

ulp- プレフィックス付きの追加のカスタムフィールド (例: 'ulp-custom-field') 。

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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

useResend · Hooks

このフックは、コード再送操作のクールダウン状態と利用可否を管理します。