Neon API (unofficial showcase)
GET/projects/{project_id}/branches/{branch_id}/auth

Retrieve Neon Auth details for the branch

Retrieves the Neon Auth integration details for the specified branch, including the auth provider type and integration status.

2 parameters
project_idstringrequired
The Neon project ID
branch_idstringrequired
The Neon branch ID

2 status codes
200Fetched the details of the Neon Auth integration for the specified branch
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 identifier assigned by the auth provider for this integration.
branch_idstringrequired
The Neon branch ID. Returned as `id` from `GET /projects/{project_id}/branches`.
db_namestringrequired
Name of the database used by the Neon Auth integration.
created_atstringrequired
Timestamp when the Neon Auth integration was created, in RFC 3339 format (UTC).
owned_bystringrequired
Owner of the auth provider project. `neon` means the project is created and managed by Neon on your behalf. `user` means the project was created in your own auth provider account and is self-managed.
Allowed:userneon
transfer_statusstringoptional
Ownership transfer state for the auth provider project. `initiated` means a transfer was requested but not completed. `finished` means it completed successfully.
Allowed:initiatedfinished
jwks_urlstringrequired
URL of the provider's JWKS endpoint used to verify JWTs.
base_urlstringoptional
Base URL of the Neon Auth service endpoint for this integration. Injected into the project environment as `NEON_AUTH_BASE_URL`.
namestringoptional
Application name shown in auth emails and communications. Defaults to the project name.
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.