Create new auth user

Creates a new user in the Neon Auth user directory for the specified branch.

POST /projects/{project_id}/branches/{branch_id}/auth/usersbeta

Creates a new user in the Neon Auth user directory for the specified branch. The user is created in the neon_auth.users_sync table and can immediately authenticate using the branch's configured auth providers.

Markdown for AI context

REST API - curl

curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/auth/users" \
  -X POST \
  -H "Authorization: Bearer $NEON_API_KEY"

Also available in

Bash

neon neon-auth user create --email <email>

Console path: Projects → Auth → Users

Parameters

Project ID

project_id

string

The Neon project ID

Branch ID

branch_id

string

The Neon branch ID

Request body

1 required Required: email.

email

string

Email address of the new Neon Auth user to create.

≥1 chars, ≤256 chars

Name

name

string

Display name for the new user. Optional. Pair with the required email field when creating a new user.

≥1 chars, ≤255 chars

Response

201

Creates new user

Depth

"id": (string),req

Errors

default

General error

This endpoint can return the standard Neon API error response.

Response fields

message Required. Human-readable error message.
code Required. Machine-readable error code.
request_id Optional. Request identifier for debugging. You can provide one with the X-Request-ID header.

Retry guidance

If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.

Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.

Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.