Sign in
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.

get/projects/{project_id}/branches/{branch_id}/auth

Request

  • Base URL: https://console.neon.tech/api/v2
  • URL: https://console.neon.tech/api/v2/projects/{project_id}/branches/{branch_id}/auth
  • Auth: one of:
    • HTTP bearer
    • API key in cookie zenith
    • API key in cookie keycloak_token

Response

Fetched the details of the Neon Auth integration for the specified branch

auth_provider'mock' | 'stack' | 'better_auth' required

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.

auth_provider_project_idstring required

Project identifier assigned by the auth provider for this integration.

branch_idstring required

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

db_namestring required

Name of the database used by the Neon Auth integration.

created_atstring date-time required

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

owned_by'user' | 'neon' required
transfer_status'initiated' | 'finished'
jwks_urlstring required

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

base_urlstring

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

namestring

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

Example response

{
  "branch_id": "br-cool-darkness-12345678",
  "created_at": "2025-01-15T10:30:00Z"
}

Changes

No recorded changes to this operation across all 15 revisions of this API.