ResetPasswordSuccess

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

reset-password-success 画面は、パスワードリセットフローの最後に表示されます。ユーザーに、パスワードが正常に変更されたことを知らせます。

​

インポート

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

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

Import Example

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

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

function ResetPasswordSuccessScreen() {
  const { screen } = useResetPasswordSuccess();
  return <p>Password reset complete for {screen.name}</p>;
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

import { useOrganization } from '@auth0/auth0-acul-react/reset-password-success';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>組織コンテキストはありません</p>;
  }
}

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembersOnResetPasswordSuccess

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

このフックは、アクティブな接続や現在のフローの状態など、reset-password-success 画面に関する transaction 固有のデータを提供します。

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useResetPasswordSuccess · ResetPasswordSuccessMembers

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

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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