1. Docs
  2. API Reference
  3. Change password (authenticated)

Change password (authenticated)

POST/v1/auth/change-password

Authenticated password change requiring the current_password and a new_password. Guarded by UserJwtGuard and rate-limited to 5 per hour; returns 401 when the current password is wrong. The new password is breach-checked and rejected if it matches any of the last 5 passwords (400), then argon2id-hashed. Existing sessions are not revoked.

Request body

application/json

current_passwordstring Required

Current password

new_passwordstring Required

New password (8-128 chars, must contain uppercase, lowercase, digit, and special character)

Responses

application/json

  • dataMessageResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

MessageResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/v1/auth/change-password" \
  -H "Content-Type: application/json" \
  -d '{
    "current_password": "string",
    "new_password": "string"
  }'
Response
{
  "data": {
    "message": "string"
  }
}
 Related endpoints
POSTRegister a new user
POSTCreate an additional Account for the authenticated admin (no new user)
GETReview the parked account-creation intent before resuming
POSTResume a deferred account creation parked at the register form
DELETEDismiss the parked account-creation intent without creating anything
POSTLook up invite details by token
POSTAccept an invite
POSTAuthenticate and receive tokens
POSTSelect an Account from a pre-auth session (multi-Account login)
POSTSwitch the active Application in an authenticated session
POSTRefresh access token
POSTLogout and revoke tokens
GETVerify email address
POSTResend verification email
POSTResend verification email by token
POSTRequest password reset
POSTReset password with token
GETGet current user profile
GETGet current user avatar image
POSTUpload profile avatar
DELETERemove profile avatar
POSTRequest an email-address change
POSTConfirm an email-address change
GETGet current user permissions
GETList the Accounts the current user belongs to
GETList active sessions
DELETERevoke all sessions
DELETERevoke a specific session
 Was this page helpful?

Tell us how we can improve this guide.

Canopy