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

Create an identity

POST/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/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

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

Requires capability env_identities.manageDeveloper Console

Create, invite, edit, and remove identities and assign their roles. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Production Environments require production_identities.accessDeveloper Console

Access identities in production Environments. Applies to users only, and only in an Environment marked production: its identities are real end users. API keys and identity principals are exempt.

Path Parameters

accountSlugstring Required

The Account's slug. An unknown one answers 404.

appSlugstring Required

The Application's slug within the Account.

envSlugstring Required

The Environment's slug within the Application.

Request body

application/json

emailstring Required
first_namestring Required
last_namestring Required
passwordstring Optional

Initial password. 8-64 characters. No composition rules — NIST SP 800-63B aligned. A HaveIBeenPwned breach check runs server-side. The effective policy is published on `GET /v1/identity/auth/config`, so a client can state the rules before submit rather than after. Omit to create a passwordless identity (sign-in via SSO or a password reset).

max length 64

external_idstring Optional
metadataobject Optional
role_idstring Optional

Role for an initial assignment — required if node_id is provided

node_idstring Optional

Node for an initial assignment — required if role_id is provided

Responses

application/json

  • dataIdentityResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on, and a correlation_id (also sent as the X-Correlation-Id header). Quote the correlation id when you contact support: it identifies the exact request in Canopy's logs.

403account.capability_requiredForbidden
When it happens

The signed-in user's administrator roles do not grant the capability this endpoint requires.

Remediation

Ask an account administrator to grant a role carrying the capability named in the Authentication section, then retry.

403environment.production_identities_forbiddenForbidden
When it happens

The Environment is marked production and the caller is a user without production identity access.

Remediation

Manage these people in the Admin Workspace, or ask an administrator to grant the Production Support role, then retry.

Returned object

IdentityResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/portal/v1/accounts/value/applications/value/environments/value/identities" \
  -H "Authorization: Bearer $CANOPY_TOKEN" \
  -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
POSTRecord a bulk-import wizard completion
GETGet an identity
PATCHUpdate an identity
DELETERemove an identity
GETGet identity detail with role assignments
GETGet identity's role assignments
GETGet identity's effective permissions
 Was this page helpful?

Tell us how we can improve this guide.

Canopy