ResetPasswordRequest

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

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

​

インポート

各画面には、それぞれ固有のフックとメソッドのセットがあります。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>
  );
}

​

Context Hooks

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

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

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

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>

このメソッドは、パスワードリセットを開始するために、ユーザー名またはメールアドレスを送信します。

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 · 必須

リセット対象のアカウントのユーザー名またはメールアドレス。

captcha? · string

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

​

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

useLoginIdentifiers · Hooks

このフックは、現在の接続に設定されているログイン識別子の種類 (email、ユーザー名、phone) を返します。

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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