/projects/{project_id}/branches/{branch_id}/auth/email_and_passwordUpdate email and password configuration
Updates the email and password authentication configuration for the specified branch's Neon Auth integration. Only the fields provided in the request body are updated.
Quick start
curl "https://console.neon.tech/api/v2/projects/$PROJECT_ID/branches/$BRANCH_ID/auth/email_and_password" \
-X PATCH \
-H "Authorization: Bearer $NEON_API_KEY"neon neon-auth config email-password updateParameters
project_idThe Neon project ID
branch_idThe Neon branch ID
Request body
No field is required.
enabledWhether email and password authentication is enabled
email_verification_methodThe email verification method to use
require_email_verificationWhether email verification is required before users can sign in
auto_sign_in_after_verificationWhether users are automatically signed in after verifying their email
send_verification_email_on_sign_upWhether to send a verification email when users sign up
send_verification_email_on_sign_inWhether to send a verification email when users sign in
disable_sign_upWhether to disable new user sign ups
Response
200The email and password configuration has been updated
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.