1. Docs
  2. API Reference
  3. Force-reset an identity's MFA — admin recovery action

Force-reset an identity's MFA — admin recovery action

POST/api/v1/identities/{id}/mfa/reset

Force-resets an identity's MFA enrollment (server-to-server admin), clearing all enrolled factors across the Account so the identity must re-enroll on next sign-in. Gated by an Environment-scoped membership check and audited. Returns 204 No Content; returns 404 when the identity has no membership in this Environment.

Authentication

Bearer TokenAuthorization Option A

JWT access token

API KeyX-API-Key Option B

API key for management-tier access

Path Parameters

idstring Required

Responses

Hard-deletes every enrolled factor, marks the current recovery-code generation redeemed, deletes every trusted-device row, and stamps `mfa_admin_reset_at`. The identity must re-enroll on next login.

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*
Request
curl -X POST "https://auth.canopy-io.com/api/v1/identities/value/mfa/reset" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
HTTP/1.1 204 Hard-deletes every enrolled factor, marks the current recovery-code generation redeemed, deletes every trusted-device row, and stamps `mfa_admin_reset_at`. The identity must re-enroll on next login.

(empty body)
 Related endpoints
GETList identities in Application
POSTCreate an identity
GETList identities with their role assignments
GETGet Application identities summary
POSTBulk-create identities
GETGet an identity
PATCHUpdate an identity
DELETERemove an identity
GETGet identity detail with role assignments
POSTActivate an identity
POSTDeactivate an identity
POSTSet an identity's password (admin)
POSTForce a password reset for an identity (admin)
POSTRevoke all of an identity's sessions (admin)
GETGet MFA enrollment summary for an identity
GETRead an identity's auth state for backend decisioning
POSTMark an identity's email verified (admin)
GETGet identity's role assignments
GETGet identity's effective permissions
GETGet where an identity holds each permission
 Was this page helpful?

Tell us how we can improve this guide.

Canopy