1. Docs
  2. API Reference
  3. Reset password with token

Reset password with token

POST/v1/auth/reset-password

Public endpoint that completes a password reset using the emailed token and a new password. Rate-limited to 5 per hour; the token must be unredeemed and within its one-hour expiry or 400 is returned. The new password is breach-checked and rejected if it matches any of the last 5 passwords, then argon2id-hashed; on success the failed-attempt lockout is cleared and all of the user's refresh tokens are revoked, forcing re-login everywhere.

Request body

application/json

tokenstring Required

Password reset token

passwordstring Required

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

Responses

application/json

  • dataMessageResponseDto*

Returned object

MessageResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/v1/auth/reset-password" \
  -H "Content-Type: application/json" \
  -d '{
    "token": "string",
    "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
POSTChange password (authenticated)
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