Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Call SuperTokens API to send the password reset email #38

Closed
rishabhpoddar opened this issue Oct 30, 2020 · 5 comments
Closed

Call SuperTokens API to send the password reset email #38

rishabhpoddar opened this issue Oct 30, 2020 · 5 comments
Assignees
Labels
enhancement New feature or request

Comments

@rishabhpoddar
Copy link
Contributor

rishabhpoddar commented Oct 30, 2020

The API will take the following as an input:

  • email (string)

  • App name (string)

  • Password reset URL (string)

  • It will send an email to email containing the App name and the Password reset URL.

  • The design of the password reset email is here.

  • Throw a 400 error when:

    • Email is syntactically bad
    • app name is ""
    • the password reset URL is an invalid URL
  • We also need a way to monitor how many emails are being sent so that our domain does not get blacklisted (in the bad case)

  • The email subject will be "Reset your password"

  • The email will be sent via: "[email protected]"

  • The name of the sender should be the same as the App name

  • The API should return and THEN sends the email.


In the SDK side, follow: #44 (comment)

@rishabhpoddar
Copy link
Contributor Author

@bhumilsarvaiya please come up with an API spec for the above. It should be a POST API.

@rishabhpoddar
Copy link
Contributor Author

@bhumilsarvaiya the API should return and THEN sends the email.

@bhumilsarvaiya
Copy link
Contributor

API Endpoint: /0/st/auth/password/reset
Method: POST
Success Response: {}
Success Response Code: 200
Possible Response Codes: 200, 400, 408, 500
Required in Request:

  • headers:
    • api-version: 0
  • request-body:
    {
        email: string,
        appName: string,
        passwordResetURL: string
    }
    

@rishabhpoddar
Copy link
Contributor Author

@bhumilsarvaiya the following changes to the password reset email:

  • "A password reset request for your account on has been received. Please click on the button below to continue further" -> "A password reset request for your account on has been received."

  • Center align the above text

@rishabhpoddar
Copy link
Contributor Author

The email does not seem render well on iOS devices
Image from iOS

@rishabhpoddar rishabhpoddar removed their assignment Nov 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants