Sign in

v1

latestOpenAPI 3.0.3Proprietary2026-07-26162247330.6 KB
Auth

Update 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.

patch/projects/{project_id}/branches/{branch_id}/auth/email_and_password

Request body

enabledboolean

Whether email and password authentication is enabled

email_verification_method'link' | 'otp'

The email verification method to use.

  • link: Sends a verification link via email
  • otp: Sends a one-time password (OTP) via email
require_email_verificationboolean

Whether email verification is required before users can sign in

auto_sign_in_after_verificationboolean

Whether users are automatically signed in after verifying their email

send_verification_email_on_sign_upboolean

Whether to send a verification email when users sign up

send_verification_email_on_sign_inboolean

Whether to send a verification email when users sign in

disable_sign_upboolean

Whether to disable new user sign ups

Response

The email and password configuration has been updated

enabledboolean required

Whether email and password authentication is enabled

email_verification_method'link' | 'otp' required

The email verification method to use.

  • link: Sends a verification link via email
  • otp: Sends a one-time password (OTP) via email
require_email_verificationboolean required

Whether email verification is required before users can sign in

auto_sign_in_after_verificationboolean required

Whether users are automatically signed in after verifying their email

send_verification_email_on_sign_upboolean required

Whether to send a verification email when users sign up

send_verification_email_on_sign_inboolean required

Whether to send a verification email when users sign in

disable_sign_upboolean required

Whether to disable new user sign ups