LoginPasswordlessEmailCode

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

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

​

インポート

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

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

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 のコンテキストデータに読み取り専用でアクセスできる、画面スコープのHooksです。@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

このフックは、id、name、logoUrl など、login-passwordless-email-code 画面向けのクライアント関連の構成を提供します。

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 画面における transaction 固有のデータを提供します。

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>
  );
}

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

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

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 接続名を使用します。

​

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

useAuth0Themes · フック

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

useChangeLanguage · フック

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

useCurrentScreen · フック

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

useErrors · フック

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

useResend · フック

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