Neon API (unofficial showcase)
PATCH/projects/{project_id}/branches/{branch_id}/auth/plugins/oauth-provider

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.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters · 5 body fields
project_idstringrequired
The Neon project ID
branch_idstringrequired
The Neon branch ID
enabledbooleanoptional
Whether the OAuth provider plugin is enabled.
login_pagestringoptional
URL of the page that authorization requests redirect to for sign-in.
consent_pagestringoptional
URL of the page that authorization requests redirect to for consent.
mcpobjectoptional
MCP resource configuration. When provided, `resource` is required and the stored MCP configuration is replaced as a whole.
resourcesarray<object>optional
Protected resources that clients can be linked to. When provided, replaces the stored list.

2 status codes
200The OAuth provider plugin configuration has been updated
enabledbooleanrequired
Whether the OAuth provider plugin is enabled.
Default:false
login_pagestringoptional
URL of the page that authorization requests redirect to for sign-in.
consent_pagestringoptional
URL of the page that authorization requests redirect to for consent.
mcpobjectoptional
MCP resource configuration.
resourcesarray<object>optional
Protected resources that clients can be linked to.
defaultGeneral Error. The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received. - If no response is returned from the API, a network error or timeout likely occurred. - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results. The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**. The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout. Any request that returns a `503 Service Unavailable` response is always safe to retry. Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress.
request_idstringoptional
Unique identifier for the request, useful for debugging. You can set this value manually by including an `X-Request-ID` header in the request. If not provided, the value will be generated automatically.
codestringrequired
Machine-readable code classifying the error type. See `message` for a human-readable explanation.
Default:
messagestringrequired
Error message

Error handling

Any other status is an error: General Error.

The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received.

  • If no response is returned from the API, a network error or timeout likely occurred.
  • In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results.

The following HTTP methods are considered non-idempotent: POST, PATCH, DELETE, and PUT. Retrying these methods is generally not safe. The following methods are considered idempotent: GET, HEAD, and OPTIONS. Retrying these methods is safe in the event of a network error or timeout.

Any request that returns a 503 Service Unavailable response is always safe to retry.

Any request that returns a 423 Locked response is safe to retry. 423 Locked indicates that the resource is temporarily locked, for example, due to another operation in progress.