STstytch
Passwords

Reset

Changed on

Reset the user's password and authenticate them. This endpoint checks that the magic link token is valid, hasn't expired, or already been used – and can optionally require additional security settings, such as the IP address and user agent matching the initial reset request.

The provided password needs to meet our password strength requirements, which can be checked in advance with the password strength endpoint. If the token and password are accepted, the password is securely stored for future authentication and the user is authenticated.

Note that a successful password reset by email will revoke all active sessions for the user_id.

post/v1/passwords/email/reset

Request

  • Base URL
    https://api.stytch.com
  • Auth
    HTTP basic

Request body

tokenstring required

The Passwords token from the ?token= query parameter in the URL.

  In the redirect URL, the `stytch_token_type` will be `login` or `reset_password`.

  See examples and read more about redirect URLs [here](https://stytch.com/docs/workspace-management/redirect-urls).
passwordstring required

The password for the user. Any UTF8 character is allowed, e.g. spaces, emojis, non-English characters, etc.

session_tokenstring

The session_token associated with a User's existing Session.

session_duration_minutesinteger

Set the session lifetime to be this many minutes from now. This will start a new session if one doesn't already exist, returning both an opaque session_token and session_jwt for this session. Remember that the session_jwt will have a fixed lifetime of five minutes regardless of the underlying session duration, and will need to be refreshed over time.

This value must be a minimum of 5 and a maximum of 527040 minutes (366 days).

If a session_token or session_jwt is provided then a successful authentication will continue to extend the session this many minutes.

If the session_duration_minutes parameter is not specified, a Stytch session will not be created.

session_jwtstring

The session_jwt associated with a User's existing Session.

code_verifierstring

A base64url encoded one time secret used to validate that the request starts and ends on the same device.

session_custom_claimsobject

Add a custom claims map to the Session being authenticated. Claims are only created if a Session is initialized by providing a value in session_duration_minutes. Claims will be included on the Session object and in the JWT. To update a key in an existing Session, supply a new value. To delete a key, supply a null value.

Custom claims made with reserved claims ("iss", "sub", "aud", "exp", "nbf", "iat", "jti") will be ignored. Total custom claims size cannot exceed four kilobytes.

telemetry_idstring

If the telemetry_id is passed, as part of this request, Stytch will call the Fingerprint Lookup API and store the associated fingerprints and IPGEO information for the User. Your workspace must be enabled for Device Fingerprinting to use this feature.

Response

Successful response

request_idstring required

Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.

user_idstring required

The unique ID of the affected User.

session_tokenstring required

A secret token for a given Stytch Session.

session_jwtstring required

The JSON Web Token (JWT) for a given Stytch Session.

status_codeinteger required

The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.

Changes