ResetPasswordEmail

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

reset-password-email 画面は、ユーザーがパスワードリセットをリクエストした後に表示されます。この画面では、リセット用のメールが送信されたことをユーザーに通知し、必要に応じてメールを再送するオプションを提供します。

​

インポート

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

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

Import Example

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

// 部分インポート
import {
  useResetPasswordEmail,
  // コンテキストHooks
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // 共通Hooks
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // ユーティリティHooks
  useChangeLanguage,
  // メソッド
  resendEmail,
} from '@auth0/auth0-acul-react/reset-password-email';

function ResetPasswordEmailScreen() {
  const { resendEmail } = useResetPasswordEmail();
  return (
    <button onClick={() => resendEmail()}>
      Resend Email
    </button>
  );
}

​

コンテキストHooks

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

このフックは、reset-password-email 画面に対する id、name、logoUrl などのクライアント関連の構成を提供します。

Example

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

useOrganization · () => OrganizationMembers

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

Example

import { useOrganization } from '@auth0/auth0-acul-react/reset-password-email';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No Organization context</p>;
  }
}

usePrompt · () => PromptMembers

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

Example

import { usePrompt } from '@auth0/auth0-acul-react/reset-password-email';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembersOnResetPasswordEmail

このフックには、構成やコンテキストを含む reset-password-email 画面固有の詳細が含まれます。

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

このフックは、アクティブな接続や現在のフローの state など、reset-password-email 画面に固有のトランザクションデータを提供します。

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useResetPasswordEmail · ResetPasswordEmailMembers

このフックは、reset-password-email 画面で利用可能なすべてのメソッドとコンテキストを返します。

​

メソッド

resendEmail · Promise<void>

このメソッドは、ユーザーにパスワードリセット用のメールを再送信します。

Example

import { useResetPasswordEmail } from '@auth0/auth0-acul-react/reset-password-email';

function ResendButton() {
  const { resendEmail } = useResetPasswordEmail();
  return (
    <button onClick={() => resendEmail()}>
      Resend Email
    </button>
  );
}

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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