1. Docs
  2. API Reference
  3. Read an identity's auth state for backend decisioning

Read an identity's auth state for backend decisioning

GET/api/v1/identities/{id}/auth-state

Returns an identity's authentication state for backend decisioning in a single call: is_active, email_verified (+ timestamp), password_set, lockout flags (locked, locked_until, failed_login_attempts), and MFA enrollment (mfa_enrolled, mfa_factor_count, mfa_admin_reset_at). This is a read — no audit row is written. 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

application/json

  • dataIdentityAuthStateResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

IdentityAuthStateResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/api/v1/identities/value/auth-state" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
{
  "data": {
    "is_active": false,
    "email_verified": false,
    "email_verified_at": "2026-04-20T12:00:00.000Z",
    "password_set": false,
    "locked": false,
    "locked_until": "2026-04-20T12:00:00.000Z",
    "failed_login_attempts": 0,
    "mfa_enrolled": false,
    "mfa_factor_count": 0,
    "mfa_admin_reset_at": "2026-04-20T12:00:00.000Z"
  }
}
 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
POSTForce-reset an identity's MFA — admin recovery action
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