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

認証フローにおける現在のプロンプトに関するデータを含みます。

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

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

captcha? · string

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