PIpipeshub-ai
User Account

Reset password

Changed on

Reset the password for the currently authenticated user.

Overview:

Allows a logged-in user to change their password by providing the current password and a new password.

Order of checks: the access token is read before the body, so a request without an Authorization header answers 400 whatever its body holds. Body fields other than the three below are dropped by the validator, and the query string is not read.

Effect on sessions: the change ends refresh tokens issued before it. The response carries a new access token.

post/userAccount/password/reset

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/userAccount/password/reset
  • Auth
    HTTP bearer

Request body

currentPasswordstring password required

The password the account has now. The validator treats it as optional; the handler then refuses a missing or empty value with 400.

newPasswordstring password required

The new password: at least 8 characters with an uppercase letter, a lowercase letter, a digit and one of #?!@$%^&*-, at most 72 bytes, and different from the current one. A value that breaks these rules is refused by the handler with 400.

cf-turnstile-responsestring

Cloudflare Turnstile CAPTCHA token (required when Turnstile is configured server-side)

Response

Password reset successfully - returns new access token

datastring required
accessTokenstring required

New JWT access token after password change

Example response

{
  "data": "password reset"
}

Changes

  • dbb5e203b445Revision changes
    • breaking

      the request property's minLength was increased from 0 to 1

    • breaking

      the request property's minLength was increased from 0 to 1

    • info

      added the media type application/x-www-form-urlencoded to the request body

  • bb0c59adf026Revision changes
    • info

      added the non-success response with the status