LoginPasswordlessEmailCode

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

login-passwordless-email-code 画面では、パスワードレス認証を完了するために、メールアドレスに送信されたワンタイムコードを入力するようユーザーに求めます。

​

インポート

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

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

Import Example

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

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

function EmailCodeForm() {
  const { submitCode } = useLoginPasswordlessEmailCode();
  return (
    <button onClick={() => submitCode({ code: '123456' })}>
      Verify Code
    </button>
  );
}

​

Context Hooks

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

このフックは、login-passwordless-email-code 画面で使用される id、name、logoUrl などのクライアント関連の設定を提供します。

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

useScreen · () => ScreenMembersOnLoginPasswordlessEmailCode

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembersOnLoginPasswordlessEmailCode

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useLoginPasswordlessEmailCode · LoginPasswordlessEmailCodeMembers

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

​

メソッド

resendCode · Promise<void>

このメソッドは、ユーザーのメールアドレスにワンタイムコードを再送します。

Example

import { useLoginPasswordlessEmailCode } from '@auth0/auth0-acul-react/login-passwordless-email-code';

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

メソッドパラメータ

表示 パラメータ

options

CustomOptions。

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

ulp- 接頭辞が付いた追加のカスタムフィールド (例: 'ulp-custom-field') 。

submitCode · Promise<void>

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

Example

import { useLoginPasswordlessEmailCode } from '@auth0/auth0-acul-react/login-passwordless-email-code';

function EmailCodeForm() {
  const { submitCode } = useLoginPasswordlessEmailCode();
  return (
    <button onClick={() => submitCode({ code: '123456' })}>
      Verify Code
    </button>
  );
}

メソッドパラメータ

表示 パラメータ

options

SubmitCodeOptions。

code · string | number · 必須

ユーザーのメールアドレスに送信されたワンタイムコード。

captcha? · string

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

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

ulp- 接頭辞が付いた追加のカスタムフィールド (例: 'ulp-custom-field') 。

switchConnection · Promise<void>

このメソッドは、フローをやり直すことなく、別の認証用接続に切り替えます。

Example

import { useLoginPasswordlessEmailCode } from '@auth0/auth0-acul-react/login-passwordless-email-code';

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

メソッドパラメータ

表示 パラメータ

options

SwitchConnectionOptionsEmailCode。

connection · string · 必須

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

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

ulp- 接頭辞が付いた追加のカスタムフィールド (例: 'ulp-custom-field') 。

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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

useResend · Hooks

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