/projects/{project_id}/branches/{branch_id}/auth/plugins/oauth-providerbetaUpdate 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.
Quick start
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"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_idThe Neon project ID
branch_idThe Neon branch ID
Request body
No field is required.
enabledWhether the OAuth provider plugin is enabled.
login_pageURL of the page that authorization requests redirect to for sign-in.
consent_pageURL of the page that authorization requests redirect to for consent.
mcpMCP resource configuration. When provided, resource is required and the stored MCP configuration is replaced as a whole.
resourcesProtected resources that clients can be linked to. When provided, replaces the stored list.
Response
200The OAuth provider plugin configuration has been updated
Errors
General error
This endpoint can return the standard Neon API error response.
Response fields
messageRequired. Human-readable error message.codeRequired. Machine-readable error code.request_idOptional. Request identifier for debugging. You can provide one with theX-Request-IDheader.
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.








