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

Create an OAuth client

Registers an OAuth client with the branch's Neon Auth OAuth provider. For confidential clients the response includes the client_secret, which is shown only once. Every entry in resources must be configured on the OAuth provider plugin.

  • 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
namestringrequired
Display name of the client.
redirect_urisarray<string>required
Redirect URIs the client may use. Must be https, or http on loopback hosts when localhost is allowed.
typestringrequired
Confidential clients authenticate with a client secret. Public clients have no secret.
Allowed:confidentialpublic
resourcesarray<string>required
Identifiers of the protected resources to link the client to. Each must be configured on the OAuth provider plugin.
skip_consentbooleanoptional
Whether to skip the consent prompt for this client.

2 status codes
201The OAuth client has been created
client_idstringrequired
The OAuth client ID.
namestringrequired
Display name of the client.
typestringrequired
Confidential clients authenticate with a client secret. Public clients have no secret.
Allowed:confidentialpublic
redirect_urisarray<string>required
Redirect URIs the client may use.
resourcesarray<string>required
Identifiers of the protected resources the client is linked to.
skip_consentbooleanrequired
Whether users are not asked for consent when authorizing this client.
disabledbooleanrequired
Whether the client is disabled.
created_atstringoptional
When the client was created.
client_secretstringoptional
The client secret. Returned only for confidential clients and only in this response.
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.