Create new auth user

Deprecated. Use /projects/{project_id}/branches/{branch_id}/auth/users instead. Removal scheduled for March 1, 2026.
The user will be created in your neon_auth.users_sync table and automatically propagated to your auth project, whether Neon-managed or provider-owned.

Body Params
string
required
^[a-z0-9-]{1,60}$

The Neon project ID. Returned as id from GET /projects.

string
enum
required

Authentication provider integrated with this Neon Auth configuration. better_auth integrates with Better Auth (the current, recommended provider). stack integrates with Stack Auth (deprecated). mock is a simulated provider for local development and testing only.

Allowed:
string
required
length between 1 and 256

Email address of the new user.

string
length between 1 and 255

Display name for the new user. When omitted, the created user has no display name.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json