Skip to main content
Build your agent on Neon and provision backends you fully control. See how Ideavo does it
/APIs & SDKs/Authentication/Update OAuth provider plugin configuration
PATCH/projects/{project_id}/branches/{branch_id}/auth/plugins/oauth-providerbeta

Update OAuth provider plugin configuration

Updates the OAuth provider plugin configuration for Neon Auth. Only the fields provided in the request body are updated; omitted fields retain their current values. A provided resources list replaces the stored list. A provided mcp object replaces the stored MCP configuration and must include resource. The plugin can only be enabled on the project's root branch.

Markdown for AI context

Quick start

REST API - curl
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/auth/plugins/oauth-provider" \
  -X PATCH \
  -H "Authorization: Bearer $NEON_API_KEY"
Also available in
import { createNeonClient, raw } from '@neon/sdk';

const neon = createNeonClient({ apiKey: process.env.NEON_API_KEY });
const { data } = await raw.updateNeonAuthOAuthProviderPlugin({
  client: neon.client,
  path: {
    project_id: process.env.PROJECT_ID,
    branch_id: process.env.BRANCH_ID
  }
});

Parameters

Project ID
project_id
string

The Neon project ID

Branch ID
branch_id
string

The Neon branch ID

Request body

No field is required.

Enabled
enabled
boolean

Whether the OAuth provider plugin is enabled.

Login page
login_page
string

URL of the page that authorization requests redirect to for sign-in.

Consent page
consent_page
string

URL of the page that authorization requests redirect to for consent.

MCP
mcp
object

MCP resource configuration. When provided, resource is required and the stored MCP configuration is replaced as a whole.

Resources
resources
array

Protected resources that clients can be linked to. When provided, replaces the stored list.

Response

200

The OAuth provider plugin configuration has been updated

Depth
"enabled": false,req
"login_page": (string),
"consent_page": (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?