Neon is expanding into a backend: Object Storage, Functions, and AI Gateway now in beta
/APIs & SDKs/Authentication/Add an OAuth provider
POST/projects/{project_id}/branches/{branch_id}/auth/oauth_providersbeta

Add an OAuth provider

Adds an OAuth provider configuration to the specified branch's Neon Auth integration. After adding, users can authenticate using the configured provider.

Markdown for AI context

Quick start

REST API - curl
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/auth/oauth_providers" \
  -X POST \
  -H "Authorization: Bearer $NEON_API_KEY"
Also available in
neon neon-auth oauth-provider add --provider-id <provider-id>

Parameters

Project ID
project_id
string

The Neon project ID

Branch ID
branch_id
string

The Neon branch ID

Request body

1 required Required: id.

ID
id
string

googlegithubmicrosoftvercel
Client ID
client_id
string

Client secret
client_secret
string

Microsoft tenant ID
microsoft_tenant_id
string

Response

200

The OAuth provider has been added to the project

Depth
"id": (string),reqgoogle | github | microsoft | vercel
"type": (string),reqstandard | shared
"client_id": (string),
"client_secret": (string),

Errors

default

General error

This endpoint can return the standard Neon API error response.

Response fields

  • message Required. Human-readable error message.
  • code Required. Machine-readable error code.
  • request_id Optional. Request identifier for debugging. You can provide one with the X-Request-ID header.

Retry guidance

If no response is returned, the request may still have reached the server. This is why retry safety depends on the method and status code.

Idempotent methods (GET, HEAD, OPTIONS) are generally safe to retry after a network error or timeout. Non-idempotent methods (POST, PATCH, DELETE, PUT) can change state, so avoid automatic retries unless your workflow can tolerate duplicate effects.

Responses with 423 Locked or 503 Service Unavailable are safe to retry. 423 Locked means the resource is temporarily locked, usually because another operation is in progress.

Was this page helpful?

On this page

Copy neon init command