/projects/{project_id}/branches/{branch_id}/authbetaEnable Neon Auth for the branch
Enables Neon Auth for the specified branch by connecting it to an authentication provider.
Creating the integration provisions the neon_auth schema in the branch database, which stores user identity data synchronized from the provider.
Quick start
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/auth" \
-X POST \
-H "Authorization: Bearer $NEON_API_KEY"neon neon-auth enableParameters
project_idThe Neon project ID
branch_idThe Neon branch ID
Request body
1 required Required: auth_provider.
auth_providerdatabase_nameResponse
201Enables Neon Auth integration for the branch
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.