ResetPassword

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

reset-password 画面では、パスワードリセットのリクエスト後に、ユーザーが新しいパスワードを設定できます。この画面はパスワードリセットフロー中に表示され、ユーザーは新しいパスワードを入力し、確認する必要があります。

​

インポート

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

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

Import Example

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

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

function ResetPasswordForm() {
  const { resetPassword } = useResetPassword();
  return (
    <button onClick={() => resetPassword({ 'password-reset': 'newSecret', 're-enter-password': 'newSecret' })}>
      Reset Password
    </button>
  );
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

useScreen · () => ScreenMembersOnResetPassword

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembersOnResetPassword

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useResetPassword · ResetPasswordMembers

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

​

メソッド

resetPassword · Promise<void>

このメソッドは、パスワードリセットフローを完了するために、ユーザーの新しいパスワードを送信します。

Example

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

function ResetPasswordForm() {
  const { resetPassword } = useResetPassword();
  return (
    <button onClick={() => resetPassword({ 'password-reset': 'newSecret', 're-enter-password': 'newSecret' })}>
      Reset Password
    </button>
  );
}

メソッドのパラメーター

表示 パラメーター

options

ResetPasswordOptions。

password-reset · string · 必須

アカウントの新しいパスワードです。

re-enter-password · string · 必須

新しいパスワードの確認用です。password-reset と一致する必要があります。

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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

usePasswordValidation · Hooks

このフックは、ユーザーのパスワードがテナントのパスワードポリシー要件を満たしているかどうかを検証します。