Sign in
Auth

Create new auth user

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.

post/projects/{project_id}/branches/{branch_id}/auth/users

Request

  • Base URL: https://console.neon.tech/api/v2
  • URL: https://console.neon.tech/api/v2/projects/{project_id}/branches/{branch_id}/auth/users
  • Auth: one of:
    • HTTP bearer
    • API key in cookie zenith
    • API key in cookie keycloak_token

Request body

emailstring email required

Email address of the new Neon Auth user to create.

namestring

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

Response

Creates new user

idstring required

ID of newly created user

Changes

No recorded changes to this operation across all 15 revisions of this API.