1. Docs
  2. API Reference
  3. Admin-trigger a password reset email

Admin-trigger a password reset email

POST/portal/v1/accounts/{accountSlug}/identities/{id}/reset-password

Authentication

  • Bearer Token Authorization

    JWT access token

Path Parameters

Name Required Type Description
idRequiredstring

Code samples

cURLJavaScriptPythonGo
curl -X POST "https://api.canopy.dev/portal/v1/accounts/{accountSlug}/identities/value/reset-password" \
  -H "Authorization: Bearer $CANOPY_TOKEN"

Responses

200 Generates a single-use reset token and emails the identity. The admin never sees the token. Distinct from the password_reset invite intent — that flow rotates a password and creates an audit trail of admin-driven recovery; this flow just initiates the self-service reset on the identity's behalf.
{
  "message": "string"
}

application/json

  • messagestring*
401 Invalid or expired token
403 This token is not authorized for this endpoint (wrong principal type — e.g., admin token on identity-only endpoint, or vice versa)
404 Identity not found

Returned object

On this page

Related endpoints

GETList identities in Account
POSTCreate an Account identity
POSTBulk-create Account identities
GETGet directory counts for the Account
GETGet an Account identity
PATCHUpdate an Account identity profile
PATCHSet Account-wide is_active flag
POSTRe-send email verification
GETList audit events for an Account identity
POSTAdd an identity to an Application (create AppMembership)
DELETERemove an identity from an Application (revoke AppMembership)