1. Docs
  2. API Reference
  3. Update an identity

Update an identity

PATCH/api/v1/identities/{id}

Updates an identity's mutable profile fields (first_name, last_name, is_active, metadata) in the current Environment. email and external_id are immutable here — external_id is owned by the SSO/SCIM provisioning path and cannot be re-pointed through this endpoint. Returns the updated identity and writes an identity.updated audit row for the profile fields; a change to is_active writes identity.status_set instead, the account-wide activation switch. Returns 404 when the identity has no membership in this Environment.

Authentication

Bearer TokenAuthorization Option A

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

API KeyX-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

Request body

application/json

first_namestring Optional
last_namestring Optional
is_activeboolean Optional
metadataobject Optional

Responses

application/json

  • dataIdentityResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

IdentityResponseDtoView all properties on this resource
Request
curl -X PATCH "https://auth.canopy-io.com/api/v1/identities/value" \
  -H "X-API-Key: $CANOPY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "string",
    "last_name": "string",
    "is_active": false,
    "metadata": {}
  }'
Response
{
  "data": {
    "id": "string",
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "avatar_url": "string",
    "external_id": "string",
    "is_active": false,
    "created_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
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
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