Sign in
Auth

Add an OAuth provider

Adds an OAuth provider configuration to the specified branch's Neon Auth integration. After adding, users can authenticate using the configured provider.

post/projects/{project_id}/branches/{branch_id}/auth/oauth_providers

Request

  • Base URL: https://console.neon.tech/api/v2
  • URL: https://console.neon.tech/api/v2/projects/{project_id}/branches/{branch_id}/auth/oauth_providers
  • Auth: one of:
    • HTTP bearer
    • API key in cookie zenith
    • API key in cookie keycloak_token

Request body

id'google' | 'github' | 'microsoft' | 'vercel' required
client_idstring

The client ID issued by the OAuth provider for your application. Used to identify the application during the OAuth flow.

client_secretstring

OAuth client secret for the provider.

microsoft_tenant_idstring

Tenant ID for the Microsoft OAuth provider. Only relevant when the OAuth provider is Microsoft; omit or leave blank for other providers.

Response

The OAuth provider has been added to the project

id'google' | 'github' | 'microsoft' | 'vercel' required
type'standard' | 'shared' required
client_idstring

Public identifier for the OAuth application, issued by the provider when the application is registered.

client_secretstring

OAuth client secret for the provider.

Changes

No recorded changes to this operation across all 15 revisions of this API.