Skip to main content
See what's recently landed on the Neon backend: Object Storage, Functions, AI Gateway, and more
/APIs & SDKs/Legacy Auth/Create Neon Auth integration
POST/projects/auth/createdeprecated

This endpoint is deprecated. Scheduled for removal on 2026-03-01.

Create Neon Auth integration

Deprecated. Use /projects/{project_id}/branches/{branch_id}/auth instead. Removal scheduled for March 1, 2026. Use this endpoint if the frontend integration flow can't be used.

Markdown for AI context

Quick start

REST API - curl
curl "https://console.neon.tech/api/v2/projects/auth/create" \
  -X POST \
  -H "Authorization: Bearer $NEON_API_KEY"
Also available in
import { createNeonClient, raw } from '@neon/sdk';

const neon = createNeonClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await raw.createNeonAuthIntegration({
  client: neon.client
});

Request body

3 required Required: auth_provider, project_id, branch_id.

Auth provider
auth_provider
string

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.

mockstackbetter_auth
Project ID
project_id
string

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

Branch ID
branch_id
string

The Neon branch ID. Returned as id from GET /projects/{project_id}/branches.

Database name
database_name
string

Name of the database to associate with the Neon Auth integration. When omitted, the integration uses the project's default database.

Role namedeprecated
role_name
string

Deprecated. The database role for the auth integration. Omit this field; it is ignored.

Response

201

Creates Neon Auth integration

Depth
"auth_provider": (string),reqmock | stack | better_auth
"auth_provider_project_id": (string),req
"pub_client_key": (string),req
"secret_server_key": (string),req
"jwks_url": (string),req
"schema_name": (string),req
"table_name": (string),req
"base_url": (string),

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.

Was this page helpful?