/projects/{project_id}/auth/oauth_providersdeprecatedThis endpoint is deprecated. Scheduled for removal on 2026-03-01.
Add an OAuth provider
Deprecated. Use /projects/{project_id}/branches/{branch_id}/auth/oauth_providers instead. Removal scheduled for March 1, 2026.
Quick start
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/auth/oauth_providers" \
-X POST \
-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.addNeonAuthOauthProvider({
client: neon.client,
path: {
project_id: process.env.PROJECT_ID
}
});Parameters
project_idThe Neon project ID
Request body
1 required Required: id.
idOAuth provider to configure for Neon Auth. Known values: google, github, microsoft, vercel, apple, discord.
discord requires custom credentials: set client_id and client_secret from your Discord application.
apple requires custom credentials: set client_id to the Services ID, client_secret to the contents of the .p8 private key, and supply apple_team_id and apple_key_id.
client_idThe client ID issued by the OAuth provider for your application. Used to identify the application during the OAuth flow.
client_secretOAuth client secret for the provider. For apple, the contents of the Sign in with Apple .p8 private key. For microsoft, the client secret value from Microsoft Entra ID.
microsoft_tenant_idTenant ID for the Microsoft OAuth provider. Only relevant when the OAuth provider is Microsoft; omit or leave blank for other providers.
apple_team_idApple Developer Team ID. Only relevant when the OAuth provider is Apple; omit for other providers.
apple_key_idKey ID of the Sign in with Apple private key supplied in client_secret. Only relevant when the OAuth provider is Apple; omit for other providers.
Response
200The OAuth provider has been added to the project
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.








