1. Docs
  2. API Reference
  3. Bulk-create identities

Bulk-create identities

POST/api/v1/identities/bulk-create

Creates many identities in one request as a partial-success operation: each row is processed independently, so per-row validation, duplicate-email (409), and breached-password (400) failures fold into a failures array instead of aborting the batch. Returns 200 when every row succeeds and 207 Multi-Status when any row fails, with successes and failures keyed by request index; same-batch duplicate emails are reported as per-row conflicts. Authorization is evaluated once up front. Supply an Idempotency-Key header to make retries safe — a replayed key returns the original result rather than re-creating rows.

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.

Headers

  • Idempotency-Key

    Optional opaque string the server uses to deduplicate retried requests. When the same key is replayed within 24 hours, the original response (status + body) is returned without re-processing — eliminates duplicate writes from network blips between server commit and client receipt. Generate one per logical operation (UUIDv4 recommended). Max 255 characters.

Request body

application/json

identitiesCreateIdentityDto[] Required

Responses

application/json

  • summaryobject*
  • resultsobject[]*

application/json

  • summaryobject*
  • results("success" | "error")[]*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*
Request
curl -X POST "https://auth.canopy-io.com/api/v1/identities/bulk-create" \
  -H "Idempotency-Key: value" \
  -H "X-API-Key: $CANOPY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "identities": [
      {
        "email": "string",
        "first_name": "string",
        "last_name": "string",
        "password": "string",
        "external_id": "string",
        "metadata": {},
        "role_id": "string",
        "node_id": "string"
      }
    ]
  }'
Response
{
  "summary": {
    "total": 0,
    "succeeded": 0,
    "failed": 0
  },
  "results": [
    {
      "index": 0,
      "status": "success",
      "code": 0,
      "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
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
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