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

Create an identity

POST/api/v1/identities

Creates a single identity in the active Application's current Environment, optionally assigning an initial role at a node in the same request (role_id + node_id). Email is normalized (lower-cased, trimmed) and must be unique within the Account — a duplicate returns 409; passwords are hashed with argon2id and screened against HaveIBeenPwned, so a breached password returns 400. Returns the created identity with profile metadata only (the password is never echoed).

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.

Request body

application/json

emailstring Required
first_namestring Required
last_namestring Required
passwordstring Optional

Initial password (8-64 chars). NIST SP 800-63B aligned — no composition rules. HaveIBeenPwned breach check runs server-side. Omit to create a passwordless identity (sign-in via SSO/social or forgot-password reset).

external_idstring Optional
metadataobject Optional
role_idstring Optional
node_idstring Optional

Responses

application/json

  • dataIdentityResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

IdentityResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/api/v1/identities" \
  -H "X-API-Key: $CANOPY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "password": "string",
    "external_id": "string",
    "metadata": {},
    "role_id": "string",
    "node_id": "string"
  }'
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
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
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