Neon API (unofficial showcase)
POST/projects/auth/createDeprecated

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.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

5 body fields
auth_providerstringrequired
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:mockstackbetter_auth
project_idstringrequired
The Neon project ID. Returned as `id` from `GET /projects`.
branch_idstringrequired
The Neon branch ID. Returned as `id` from `GET /projects/{project_id}/branches`.
database_namestringoptional
Name of the database to associate with the Neon Auth integration. When omitted, the integration uses the project's default database.
role_namestringdeprecatedoptional
Deprecated. The database role for the auth integration. Omit this field; it is ignored.

2 status codes
201Creates Neon Auth integration
auth_providerstringrequired
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:mockstackbetter_auth
auth_provider_project_idstringrequired
Project ID assigned by the auth provider for this integration.
pub_client_keystringrequired
Publishable SDK key from the auth provider. Populated only for Stack Auth (deprecated); empty for Better Auth.
secret_server_keystringrequired
Secret server-side SDK key from the auth provider. Populated only for Stack Auth (deprecated); empty for Better Auth. Treat as a credential.
jwks_urlstringrequired
URL of the provider's JWKS endpoint used to verify JWTs.
schema_namestringrequired
Postgres schema containing the auth integration tables. Defaults to `neon_auth`.
table_namestringrequired
Postgres table in the integration schema where synced user records are stored.
base_urlstringoptional
Base URL of the Neon Auth service for this integration. Set as the NEON_AUTH_BASE_URL environment variable in your application.
defaultGeneral Error. The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received. - If no response is returned from the API, a network error or timeout likely occurred. - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results. The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**. The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout. Any request that returns a `503 Service Unavailable` response is always safe to retry. Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress.
request_idstringoptional
Unique identifier for the request, useful for debugging. You can set this value manually by including an `X-Request-ID` header in the request. If not provided, the value will be generated automatically.
codestringrequired
Machine-readable code classifying the error type. See `message` for a human-readable explanation.
Default:
messagestringrequired
Error message

Error handling

Any other status is an error: General Error.

The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received.

  • If no response is returned from the API, a network error or timeout likely occurred.
  • In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results.

The following HTTP methods are considered non-idempotent: POST, PATCH, DELETE, and PUT. Retrying these methods is generally not safe. The following methods are considered idempotent: GET, HEAD, and OPTIONS. Retrying these methods is safe in the event of a network error or timeout.

Any request that returns a 503 Service Unavailable response is always safe to retry.

Any request that returns a 423 Locked response is safe to retry. 423 Locked indicates that the resource is temporarily locked, for example, due to another operation in progress.