1. Docs
  2. API Reference
  3. Request password reset

Request password reset

POST/v1/auth/forgot-password

Public endpoint that issues a one-hour password-reset token for the given email and emails the reset link. Rate-limited to 5 per hour. Always responds with a generic success message whether or not a matching user exists, to prevent account enumeration.

Request body

application/json

emailstring Required

Email address

Responses

application/json

  • dataMessageResponseDto*

Returned object

MessageResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/v1/auth/forgot-password" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "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
POSTReset password with token
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