/auth/forgot-password/{token}

POST /auth/forgot-password/{token}

Reset password using token

Sets a new password using a valid password reset token

Required Parameters

token path string

Password reset token received in email

Request Body

{
  "pw1": "string",
  "pw2": "string"
}

{
  "pw1": "newSecurePassword789",
  "pw2": "newSecurePassword789"
}

{
  "pw1": "string",
  "pw2": "string"
}

Try it out

Output:

Responses

Description

Password reset successful

{
  "message": "Password has been reset successfully"
}

Description

Bad request - passwords don't match or don't meet requirements

{
  "error": "string",
  "status": 0,
  "message": "string"
}

Description

Not found - token is invalid or expired

{
  "error": "string",
  "status": 0,
  "message": "string"
}

Description

Internal server error

{
  "error": "string",
  "status": 0,
  "message": "string"
}

References

#/components/schemas/Error

OpenAPI
TypeScript

type: object
properties:
  error:
    type: string
    description: Error message
  status:
    type: integer
    description: HTTP status code
  message:
    type: string
    description: Detailed error message
description: Error response object
required:
  - error

|
export interface Error {
  /** Error message */
  error: string;
  /** HTTP status code */
  status?: number;
  /** Detailed error message */
  message?: string;
}

Route Source Code

Check out the source code for this route entrypoint here: /auth/forgot-password/[token]/route.ts

Or the swagger.yaml spec this documentation was generated from: /auth/forgot-password/[token]/swagger.yaml