Skip to main content
Neon Postgres Docs

Search documentation

Type to search this documentation.

List active integrations with auth providers

GET/projects/{project_id}/auth/integrationsList active integrations with auth providers

Deprecated. Use /projects/{project_id}/branches/{branch_id}/auth instead. Removal scheduled for March 1, 2026.

Parameters

project_idstringpathrequired

The Neon project ID

pattern ^[a-z0-9-]{1,60}$

Responses

200Return management API keys metadataapplication/json
objectListNeonAuthIntegrationsResponse
dataarray of objectrequired

Neon Auth integrations configured for the project.

Show child attributes
Show array items
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.

one of "mock", "stack", "better_auth"

auth_provider_project_idstringrequired

Project identifier assigned by the auth provider for this integration.

base_urlstring

Base URL of the Neon Auth service endpoint for this integration. Injected into the project environment as `NEON_AUTH_BASE_URL`.

branch_idstringrequired

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

pattern ^[a-z0-9-]{1,60}$

created_atstring · date-timerequired

Timestamp when the Neon Auth integration was created, in RFC 3339 format (UTC).

db_namestringrequired

Name of the database used by the Neon Auth integration.

jwks_urlstringrequired

URL of the provider's JWKS endpoint used to verify JWTs.

namestring

Application name shown in auth emails and communications. Defaults to the project name.

maxLength 256 · minLength 1

owned_bystringrequired

one of "user", "neon"

transfer_statusstring

one of "initiated", "finished"

Example response
{
  "data": [
    {
      "auth_provider": "better_auth",
      "auth_provider_project_id": "string",
      "base_url": "string",
      "branch_id": "br-cool-darkness-12345678",
      "created_at": "2025-01-15T10:30:00Z",
      "db_name": "string",
      "jwks_url": "string",
      "name": "string",
      "owned_by": "neon",
      "transfer_status": "finished"
    }
  ]
}
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. application/json
objectGeneralError
codestringrequired

default ""

messagestringrequired

Error message

request_idstring

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.

Example response
{
  "code": "",
  "message": "string",
  "request_id": "string"
}
Documentation menu