Package com.stytch.sdk.b2b.passwords

Class Passwords.Discovery.ResetByEmailStartParameters

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      final String getEmailAddress()

      • The email that requested the password reset
      final String getDiscoveryRedirectUrl()

      • The url that the Member clicks from the password reset email to skip resetting their password and directly login. This should be a url that your app receives, parses, and subsequently sends an API request to the magic link authenticate endpoint to complete the login process without reseting their password. If this value is not passed, the login redirect URL that you set in your Dashboard is used. If you have not set a default login redirect URL, an error is returned.
      final String getResetPasswordRedirectUrl()

      • The url that the Member clicks from the password reset email to finish the reset password flow. This should be a url that your app receives and parses before showing your app's reset password page. After the Member submits a new password to your app, it should send an API request to complete the password reset process. If this value is not passed, the default reset password redirect URL that you set in your Dashboard is used. If you have not set a default reset password redirect URL, an error is returned.
      final Integer getResetPasswordExpirationMinutes()

      • Set the expiration for the password reset, in minutes. By default, it expires in 30 minutes. The minimum expiration is 5 minutes and the maximum is 7 days (10080 mins).
      final String getResetPasswordTemplateId()

      • The email template ID to use for password reset. If not provided, your default email template will be sent. If providing a template ID, it must be either a template using Stytch's customizations, or a Passwords reset custom HTML template.
      final String getVerifyEmailTemplateId() Use a custom template for password verify emails.
      final Locale getLocale()

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Passwords.Discovery.ResetByEmailStartParameters

        Passwords.Discovery.ResetByEmailStartParameters(String emailAddress, String discoveryRedirectUrl, String resetPasswordRedirectUrl, Integer resetPasswordExpirationMinutes, String resetPasswordTemplateId, String verifyEmailTemplateId, Locale locale)

    • Method Detail

      • getDiscoveryRedirectUrl

         final String getDiscoveryRedirectUrl()

        • The url that the Member clicks from the password reset email to skip resetting their password and directly login. This should be a url that your app receives, parses, and subsequently sends an API request to the magic link authenticate endpoint to complete the login process without reseting their password. If this value is not passed, the login redirect URL that you set in your Dashboard is used. If you have not set a default login redirect URL, an error is returned.

      • getResetPasswordRedirectUrl

         final String getResetPasswordRedirectUrl()

        • The url that the Member clicks from the password reset email to finish the reset password flow. This should be a url that your app receives and parses before showing your app's reset password page. After the Member submits a new password to your app, it should send an API request to complete the password reset process. If this value is not passed, the default reset password redirect URL that you set in your Dashboard is used. If you have not set a default reset password redirect URL, an error is returned.

      • getResetPasswordExpirationMinutes

         final Integer getResetPasswordExpirationMinutes()

        • Set the expiration for the password reset, in minutes. By default, it expires in 30 minutes. The minimum expiration is 5 minutes and the maximum is 7 days (10080 mins).

      • getResetPasswordTemplateId

         final String getResetPasswordTemplateId()

        • The email template ID to use for password reset. If not provided, your default email template will be sent. If providing a template ID, it must be either a template using Stytch's customizations, or a Passwords reset custom HTML template.

      • getVerifyEmailTemplateId

         final String getVerifyEmailTemplateId()

        Use a custom template for password verify emails. By default, it will use your default email template. The template must be a template using our built-in customizations or a custom HTML email for Password Verification.