Skip to main content

Type Alias: ForgotPassword()

ForgotPassword = (email) => Promise<SuccessResponse | AuthError>

Initiates the password recovery process for a user account. This sends a verification code to the user's email address, which can then be used with forgotPasswordSubmit to reset their password.

Parameters​

email​

string

Email address of the user account

Returns​

Promise<SuccessResponse | AuthError>

A promise resolving to a success response or error information

Example​

window.mimeeqAuth.authorization.forgotPassword('[email protected]')
  .then(response => {
    if (response.success) {
      console.log('Password reset code sent! Check your email.');
      // Show the code input field and new password fields
    } else {
      console.error('Failed to initiate password reset');
    }
  });