startPasswordReset method

Future<UuidValue> startPasswordReset(Session session, { required String email, })

Requests a password reset for email.

If the email address is registered, an email with reset instructions will be send out. If the email is unknown, this method will have no effect.

Always returns a password reset request ID, which can be used to complete the reset. If the email is not registered, the returned ID will not be valid.

Throws an EmailAccountPasswordResetException in case of errors, with reason:

• EmailAccountPasswordResetExceptionReason.tooManyAttempts if the user has made too many attempts trying to request a password reset.

Implementation

Future<UuidValue> startPasswordReset(
  final Session session, {
  required final String email,
}) async {
  return emailIdp.startPasswordReset(session, email: email);
}