LoginPasswordlessSmsOtp

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

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

​

インポート

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

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

Import Example

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

// 部分インポート
import {
  useLoginPasswordlessSmsOtp,
  // コンテキストHooks
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // 共通Hooks
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // ユーティリティHooks
  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 のコンテキストデータへの読み取り専用アクセスを提供する、画面に対してスコープが設定された Hooks です。@auth0/auth0-acul-react/login-passwordless-sms-otp からインポートします。

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

この Hooks は、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

この Hooks は、ログインが organization にスコープ設定されている場合に、ユーザーの 組織 に関する情報を提供します。組織コンテキストが存在しない場合は 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

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

Example

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

useScreen · () => ScreenMembersOnLoginPasswordlessSmsOtp

この Hooks には、login-passwordless-sms-otp 画面に固有の詳細情報 (設定やコンテキストを含む) が含まれます。

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembersOnLoginPasswordlessSmsOtp

この Hooks は、login-passwordless-sms-otp 画面の transaction 固有のデータ (有効な 接続 や現在のフロー state など) を提供します。

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

この Hooks は、アクティブなユーザーの詳細情報 (username、email、利用可能な認証方法など) を提供します。

Example

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

useLoginPasswordlessSmsOtp · LoginPasswordlessSmsOtpMembers

この Hooks は、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()}>
      コードを再送信
    </button>
  );
}

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' })}>
      コードを検証
    </button>
  );
}

メソッドのパラメータ

表示 パラメータ

options

SubmitOTPOptions.

code · string · 必須

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

username? · string

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

captcha? · string

テナントでボット検出が有効な場合に必要な captcha 値。

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' })}>
      SSO を使用
    </button>
  );
}

メソッドのパラメータ

表示 パラメータ

options

SwitchConnectionOptionsSmsOtp.

connection · string · 必須

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

​

共通/Utility Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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

useResend · Hooks

このフックは、コード再送アクションの再送クールダウンの state と利用可否を管理します。