ResetPasswordRequest

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

ResetPasswordRequest クラスは、reset-password-request 画面の機能を実装します。この画面では、パスワードリセットフローを開始するために、ユーザーに識別子の入力を求めます。

​

コンストラクター

ResetPasswordRequest画面マネージャーのインスタンスを作成します：

Example

import ResetPasswordRequest from '@auth0/auth0-acul-js/reset-password-request';
const resetPasswordRequestManager = new ResetPasswordRequest();
await resetPasswordRequestManager.resetPassword({ username: 'testuser' });

​

プロパティ

branding · BrandingMembers

ブランディングテーマや設定など、ブランディングに関する構成情報を提供します。

client · ClientMembers

reset-password-request 画面向けに、id、name、logoUrl などのクライアント関連の構成情報を提供します。

organization · OrganizationMembers

ユーザーの組織に関する情報 (id や name など) を提供します。

prompt · PromptMembers

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

screen · ScreenMembersOnResetPasswordRequest

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

tenant · TenantMembers

id や関連するメタデータなど、テナントに関するデータが含まれます。

transaction · TransactionMembersOnResetPasswordRequest

有効な識別子やフローの状態など、reset-password-request 画面向けのトランザクション固有のデータを提供します。

untrustedData · UntrustedDataMembers

パスワードリセットリクエストフロー中のユーザー入力など、SDK に渡される信頼できないデータを扱います。

user · UserMembers

username、email、roles など、現在アクティブなユーザーの詳細です。

​

メソッド

backToLogin · Promise<void>

このメソッドは、ユーザーをログイン画面に戻します。

Example

import ResetPasswordRequest from '@auth0/auth0-acul-js/reset-password-request';
const resetPasswordRequestManager = new ResetPasswordRequest();
await resetPasswordRequestManager.backToLogin();

changeLanguage · Promise<void>

このメソッドは、Universal Login ページの表示言語を変更します。

Example

import ResetPasswordRequest from '@auth0/auth0-acul-js/reset-password-request';
const resetPasswordRequestManager = new ResetPasswordRequest();
resetPasswordRequestManager.changeLanguage({
  language: 'fr',
});

メソッドのパラメーター

表示 パラメーター

options

LanguageChangeOptions。

language · string · 必須

使用する言語のロケールコードです (例: 'en'、'fr'、'es') 。

persist? · "session"

'session' に設定すると、選択した言語がセッション中維持されます。

getErrors · Error []

このメソッドは、コンテキストからトランザクションエラーの配列を取得します。エラーがない場合は空の配列を返します。

getLoginIdentifiers · ScreenIdentifierType []

このメソッドは、reset-password-request 画面で設定されている有効な識別子タイプ (username や email など) を返します。

Example

import ResetPasswordRequest from '@auth0/auth0-acul-js/reset-password-request';
const resetPasswordRequestManager = new ResetPasswordRequest();
resetPasswordRequestManager.getLoginIdentifiers();

resetPassword · Promise<void>

このメソッドは、ユーザーの識別子を送信してパスワードリセットフローを開始します。

Example

import ResetPasswordRequest from '@auth0/auth0-acul-js/reset-password-request';
const resetPasswordRequestManager = new ResetPasswordRequest();
await resetPasswordRequestManager.resetPassword({ username: 'testuser' });

メソッドのパラメーター

表示 パラメーター

options

ResetPasswordRequestOptions。

username · string · 必須

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

captcha? · string

このテナントで CAPTCHA が有効な場合の CAPTCHA 応答トークンです。