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パラメーター から渡されるユーザー名など、画面に渡された信頼できないデータを扱います。

Example

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

useUser · () => UserMembers

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

例

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 と一致している必要があります。

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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

usePasswordValidation · Hooks

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