ResetPasswordRequest

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

reset-password-request 画面は、パスワードリセットフローの開始時に表示されます。ユーザーは、パスワードリセットリンクを受け取るために、username またはメールアドレスを入力するよう求められます。

​

インポート

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

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

Import Example

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

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

function ResetPasswordRequestScreen() {
  const { resetPassword } = useResetPasswordRequest();
  return (
    <button onClick={() => resetPassword({ username: '[e-mail]' })}>
      Send Reset Link
    </button>
  );
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

useScreen · () => ScreenMembersOnResetPasswordRequest

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembersOnResetPasswordRequest

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useResetPasswordRequest · ResetPasswordRequestMembers

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

​

メソッド

backToLogin · Promise<void>

このメソッドはユーザーをログイン画面に戻し、パスワードリセットフローをキャンセルします。

Example

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

function BackToLoginButton() {
  const { backToLogin } = useResetPasswordRequest();
  return (
    <button onClick={() => backToLogin()}>
      Back to Login
    </button>
  );
}

resetPassword · Promise<void>

このメソッドは、usernameまたはメールアドレスを送信して、パスワードリセット処理を開始します。

Example

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

function ResetPasswordForm() {
  const { resetPassword } = useResetPasswordRequest();
  return (
    <button onClick={() => resetPassword({ username: '[e-mail]' })}>
      Send Reset Link
    </button>
  );
}

メソッドパラメーター

表示 パラメーター

options

ResetPasswordRequestOptions。

username · string · 必須

リセットするアカウントのusernameまたはメールアドレス。

captcha? · string

CAPTCHA がテナントで有効になっている場合に必要な、CAPTCHA 応答トークンです。

​

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

useLoginIdentifiers · Hooks

このフックは、現在の接続に設定されているログイン識別子の種類 (メールアドレス、username、電話番号) を返します。

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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