Identra Docs
Reference / Users

change a user's status (ban/lock/reactivate). Emits `user.updated`.

PATCH /v1/users/{id}
Secret API key operationId: patch

Authorization

Server-to-server. Send a secret key as a Bearer token plus the x-application-id header.

Path parameters

  • id string<uuid> required

    User id

Request body · required

  • status string required

    New status: `active | banned | locked`.

Responses

200 Updated
{
  "data": {
    "created_at": "2026-01-15T09:30:00Z",
    "email_verified": false,
    "id": "018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f",
    "primary_email": "string",
    "profile": {},
    "status": "string"
  },
  "error": {
    "code": "string",
    "message": "string"
  },
  "meta": {
    "timestamp": "string"
  },
  "success": false
}
422 Invalid status

Request

curl -X PATCH "http://localhost:8080/v1/users/018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "string"
}'

Try it

live request
PATCH http://localhost:8080/v1/users/018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f

Path parameters

Request body

application/json