ResetPasswordEmail

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

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

​

インポート

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

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

Import Example

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

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

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

​

コンテキストフック

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

このフックには、認証フローにおける現在の prompt に関するデータが含まれます。

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

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

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()}>
      メールを再送
    </button>
  );
}

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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