ResetPasswordError

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

reset-password-error 画面は、リセットリンクの期限切れや無効化など、パスワードリセットフロー中にエラーが発生した場合に表示されます。この画面では、発生した問題をユーザーに知らせるとともに、次に実行すべき手順を案内します。

​

インポート

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

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

Import Example

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

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

function ResetPasswordErrorScreen() {
  const screen = useScreen();
  return <p>{screen.name}</p>;
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

useScreen · () => ScreenMembersOnResetPasswordError

このフックには、設定やコンテキストなど、reset-password-error 画面固有の詳細が含まれます。

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useResetPasswordError · ResetPasswordErrorMembers

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

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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