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/portal/v1/accounts/{accountSlug}/identities/{id}/mfa/reset

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/mfa/reset" \
  -H "Authorization: Bearer $CANOPY_TOKEN"

Responses

200 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.
{
  "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

GETGet MFA enrollment summary for an identity