Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Neon Auth API

Manage Neon Auth configuration for branches, including OAuth providers, webhooks, and authentication settings.

Neon Auth API is one of 13 APIs that Neon publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Auth. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 3 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 2.0.

Requests are made against a single base URL, https://console.neon.tech/api/v2.

6 operations 3 paths 5 schemas 1 DELETE2 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0
Base URL
https://console.neon.tech/api/v2
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Neon Auth API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (API Key) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Neon API keys are used to authenticate requests. Include the API key in the Authorization header as a Bearer token.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Auth 6

Manage Neon Auth configuration for branches, including OAuth providers, webhooks, and authentication settings.

GET
/projects/{project_id}/branches/{branch_id}/auth
Get Auth configuration
getProjectBranchAuth 2 params → 200401404
PUT
/projects/{project_id}/branches/{branch_id}/auth
Update Auth configuration
updateProjectBranchAuth 2 params body → 200400401404
GET
/projects/{project_id}/branches/{branch_id}/auth/providers
List OAuth providers
listNeonAuthOAuthProviders 2 params → 200401404
POST
/projects/{project_id}/branches/{branch_id}/auth/providers
Create an OAuth provider
createNeonAuthOAuthProvider 2 params body → 201400401404
PATCH
/projects/{project_id}/branches/{branch_id}/auth/providers/{provider_id}
Update an OAuth provider
updateNeonAuthOAuthProvider 3 params body → 200400401404
DELETE
/projects/{project_id}/branches/{branch_id}/auth/providers/{provider_id}
Delete an OAuth provider
deleteNeonAuthOAuthProvider 3 params → 200401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are OAuthProvider (6 properties), AuthConfig (4 properties), OAuthProviderCreateRequest (4 properties), OAuthProviderUpdateRequest (3 properties). Each schema is shown below with its type and property counts.

OAuthProviderUpdateRequest
object
Request body for updating an OAuth provider
3 properties
OAuthProvider
object
An OAuth provider configuration for Neon Auth
6 properties
OAuthProviderCreateRequest
object
Request body for creating a new OAuth provider
4 properties 3 required
AuthConfig
object
Neon Auth configuration for a branch, providing managed authentication built on Better Auth.
4 properties
AuthConfigUpdate
object
Request body for updating Auth configuration
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

neon-auth-api-openapi.yml Raw ↑

Other APIs Neon publishes across the network.

Neon Data API
Neon Serverless Driver
Neon Auth
Neon API Keys API
Neon Branches API
Neon Consumption API
Neon Data API API
Neon Databases API
Neon Endpoints API
Neon Operations API
Neon Projects API
Neon Roles API