Force a password reset for an identity (admin)
/api/v1/identities/{id}/password/resetTriggers the soft password-reset path for an identity: emails a reset link valid for one hour while leaving the current password and existing sessions intact until the identity completes the reset. The email is sent fire-and-forget, so a transport failure does not fail the request. For an immediate hard cut, compose this with the revoke-sessions endpoint or set the password outright. Returns 204 No Content; returns 404 when the identity has no membership in this Environment.
Authentication
Authorization Option A JWT access token. Never send alongside X-API-Key: a request carrying both is refused.
X-API-Key Option B API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.
Path Parameters
idstring Required Responses
A password-reset email is sent so the identity can choose a new password. The current password and existing sessions stay valid until the reset link is used (completing the reset then rotates the password and revokes sessions). For an immediate hard cut, use the revoke-sessions endpoint; to rotate the password outright, use set-password.
application/json
errorApiErrorBodyDto
application/json
errorApiErrorBodyDto
application/json
errorApiErrorBodyDto
application/json
errorApiErrorBodyDto
curl -X POST "https://auth.canopy-io.com/api/v1/identities/value/password/reset" \ -H "X-API-Key: $CANOPY_API_KEY"
HTTP/1.1 204 A password-reset email is sent so the identity can choose a new password. The current password and existing sessions stay valid until the reset link is used (completing the reset then rotates the password and revokes sessions). For an immediate hard cut, use the revoke-sessions endpoint; to rotate the password outright, use set-password. (empty body)
Tell us how we can improve this guide.