/projects/auth/createdeprecatedThis 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.
Quick start
curl "https://console.neon.tech/api/v2/projects/auth/create" \
-X POST \
-H "Authorization: Bearer $NEON_API_KEY"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_providerAuthentication 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.
project_idThe Neon project ID. Returned as id from GET /projects.
branch_idThe Neon branch ID. Returned as id from GET /projects/{project_id}/branches.
database_nameName of the database to associate with the Neon Auth integration. When omitted, the integration uses the project's default database.
role_nameDeprecated. The database role for the auth integration. Omit this field; it is ignored.
Response
201Creates Neon Auth integration
Errors
General error
This endpoint can return the standard Neon API error response.
Response fields
messageRequired. Human-readable error message.codeRequired. Machine-readable error code.request_idOptional. Request identifier for debugging. You can provide one with theX-Request-IDheader.
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.








