Neon API (unofficial showcase)
GET/projects/{project_id}/branches/{branch_id}/auth/plugins

Retrieve Neon Auth plugin configurations

Returns all plugin configurations for Neon Auth in a single response. This endpoint aggregates organization, email provider, email and password, OAuth providers, and localhost settings.

2 parameters
project_idstringrequired
The Neon project ID
branch_idstringrequired
The Neon branch ID

2 status codes
200Returns all plugin configurations
organizationobjectoptional
Configuration for the Neon Auth organization plugin, which enables user organizations within the authentication system. This is distinct from a Neon platform organization.
magic_linkobjectoptional
Configuration for passwordless magic-link email authentication.
phone_numberobjectoptional
Configuration for the phone number authentication plugin.
oauth_providerobjectoptional
Configuration for the OAuth provider plugin, which lets Neon Auth act as an OAuth authorization server for your own clients.
email_providerobjectoptional
Email server configuration used to send authentication emails.
email_and_passwordobjectoptional
Configuration for email and password authentication.
oauth_providersarray<object>optional
OAuth provider configurations enabled for this auth setup.
allow_localhostbooleanoptional
Permits authentication requests from localhost origins when true. Intended for local development; disable in production environments.
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.