Reset Password
Use the Reset Password entry point to move users into the password recovery flow when they cannot sign in.
This entry point allows anonymous access and routes users to the Reset Password Request screen.
This screen includes:
- A Forgot your password? Click here to reset link on the Log in and Change Password screens.
- A redirect to the Reset Password Request screen.
- No input fields or interactive form elements.
- Anonymous access without a session.
- A support link for users who need additional help.
Workflow
- Open the Log in or Change Password screen.
- Select Forgot your password?.
- The app redirects to the Reset Password Request screen.
The user enters the email and requests a reset link as part of that flow.
Validations
| Scenario | App Behavior | SDK Output |
|---|---|---|
| User does not select the Forgot your password? link. | Does not open the reset flow. | No change in state. |
| User opens the link from a non-authenticated context. | Grants access and displays the Reset Password Request screen. | Returns an anonymous session state. |
The Reset Password entry point accepts no input and performs no local validation.
Actions
| Scenario | App Behavior | SDK Output |
|---|---|---|
| User selects Forgot your password?. | Redirects to the Reset Password Request screen. | Returns a navigation event into the reset flow. |
| User accesses the link without a session. | Allows access to the reset request flow. | Maintains an unauthenticated state. |
This entry point does not handle form submission, token validation, or password update logic.
Endpoint Resources
Reset Password Configuration
PUT
/account/password/reset
This endpoint returns configuration for the password reset screen that consumes a valid reset token and sets a new password.
Redirect target
- This entry point does not accept data.
- It routes users into the Reset Password Request flow.
- You may expose this entry point from login or account settings in unauthenticated flows.
Reset Password
POST
/account/password/reset
This endpoint updates the user’s account with a new password by using a valid reset token.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | String | Yes | Unique reset code from email link |
new-password | String | Yes | New password for the user account |
Errors
| Code | Description |
|---|---|
FIELDS_VALIDATION_ERROR | One or more required fields are invalid. |
RESET_PASSWORD_CODE_INVALID | The provided reset code is expired or invalid. |