/gate/password-reset/redeemRedeem Password Reset
Completes a password reset by accepting the single-use reset token and the new password.
On success, the end-user's password hash is updated, all existing sessions and refresh tokens are revoked, and a fresh Gate JWT is issued.
Returns K9O_PASSWORD_RESET_TOKEN_EXPIRED (410) if the token is expired or already used.
| projectSlug * | path | The project's slug: the path segment after It is unique within the org. |
| token * | string | The reset code from the email. It works once and expires one hour after it was sent. |
| newPassword * | string | The new password, at least 12 characters. A password found in known data breaches is refused. |
| HTTP | K9O Code | Description |
|---|---|---|
| 200 | Success | |
| 400 | K9O_INVALID_REQUEST_SHAPE | The new password is shorter than the minimum length required by the request schema. |
| 400 | K9O_INVALID_FIELD_VALUE | The password-reset token is invalid, has expired, or has already been used. |
| 400 | K9O_PASSWORD_COMPROMISED | The new password appears in a known data breach at or above the project's threshold (the project's have-i-been-pwned install, with its Gate block on). Choose a different password; context is empty. |
| 404 | K9O_END_USER_NOT_FOUND | No end-user record matches the identity associated with the supplied password-reset token. |
| data * | any | Either |
| One of: object | ||
| redeemed * | true | Always |
| session * | object | The tokens for the new session. Keep the refresh token for |
| accessToken * | string | A signed JWT that authenticates the end user to this project's API. Send it as Its subject ( It lives for the project's end-user access token lifetime: 30 minutes by default, settable from 5 to 60 minutes. It cannot be revoked early: signing out or revoking sessions stops the next refresh, but a token already issued stays valid until |
| refreshToken * | string | An opaque secret (43 base64url characters) that gets a new access token from Store it securely and never send it anywhere else. It is single use: every refresh returns a new refresh token, and sending the one it replaced a second time ends the whole session. It stops working when the session ends: on sign-out, a password reset, a revoke-all, or when the project's session limits are reached (by default 30 days without a refresh, or 90 days after sign-in, whichever comes first). |
| expiresAt * | string <date-time> | When Refresh before this time to keep the end user signed in. |
| endUserId * | string | The end user whose password changed ( |
| or: object | ||
| redeemed * | true | Always |
| mfa * | object | Present instead of |
| required * | true | Always |
| challengeId * | string | An opaque, single-use id for this sign-in (43 base64url characters). Send it with a current code from the end user's authenticator app to A new sign-in by the same door replaces it, and it dies after 5 wrong codes. |
| expiresAt * | string <date-time> | When the challenge expires, 5 minutes after it was issued. After that the end user signs in again. |
| methodsAvailable * | "totp"[] | The second factors that can answer this challenge. Always |
| resident * | object | Where the challenge lives. |
| region * | string | The region that holds the end user and this challenge. |
| origin * | string | That region's API origin. Send the challenge answer here: no other region has the challenge. |
| endUserId * | string | The end user whose password changed ( |
| meta * | any | Request metadata: cost, timing and the request and trace ids. |
// const k9o = new K9o({ orgSlug: 'playground', projectSlug: 'storefront', apiKey: 'k9o_…' })
const { data } = await k9o.gate.passwordReset.redeem({
token: 'EXAMPLE-reset-token-not-a-real-secret-0000',
newPassword: 'correct-horse-battery-staple'
})Showing example in TypeScript
{
"token": "EXAMPLE-reset-token-not-a-real-secret-0000",
"newPassword": "correct-horse-battery-staple"
}{
"data": {
"redeemed": true,
"session": {
"accessToken": "string",
"refreshToken": "string",
"expiresAt": "string"
},
"endUserId": "string"
}
}