Update email and password configuration

PATCH/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.

Parameters

project_idstringpathrequired

The Neon project ID

pattern ^[a-z0-9-]{1,60}$

branch_idstringpathrequired

The Neon branch ID

pattern ^[a-z0-9-]{1,60}$

Request body

required

application/json

objectNeonAuthEmailAndPasswordConfigUpdate

auto_sign_in_after_verificationboolean

Whether users are automatically signed in after verifying their email

disable_sign_upboolean

Whether to disable new user sign ups. When omitted, the current setting is not changed.

email_verification_methodstring

The email verification method to use. - `link`: Sends a verification link via email - `otp`: Sends a one-time password (OTP) via email

one of "link", "otp"

enabledboolean

Controls whether email and password authentication is enabled for this project. When omitted from an update request, the current value is unchanged.

require_email_verificationboolean

When true, users must verify their email address before they can sign in. Omitting this field from an update request leaves the current value unchanged.

send_verification_email_on_sign_inboolean

Whether to send a verification email when a user with an unverified email signs in.

send_verification_email_on_sign_upboolean

Whether to send a verification email when users sign up.

Example request

{
  "auto_sign_in_after_verification": true,
  "disable_sign_up": true,
  "email_verification_method": "link",
  "enabled": true,
  "require_email_verification": true,
  "send_verification_email_on_sign_in": true,
  "send_verification_email_on_sign_up": true
}

Responses

objectNeonAuthEmailAndPasswordConfig

auto_sign_in_after_verificationbooleanrequired

Whether users are automatically signed in after verifying their email

disable_sign_upbooleanrequired

Whether to disable new user sign ups

email_verification_methodstringrequired

The email verification method to use. - `link`: Sends a verification link via email - `otp`: Sends a one-time password (OTP) via email

one of "link", "otp"

enabledbooleanrequired

Whether email and password authentication is enabled

require_email_verificationbooleanrequired

Whether email verification is required before users can sign in

send_verification_email_on_sign_inbooleanrequired

Whether to send a verification email when users sign in

send_verification_email_on_sign_upbooleanrequired

Whether to send a verification email when users sign up

Example response

{
  "auto_sign_in_after_verification": true,
  "disable_sign_up": true,
  "email_verification_method": "link",
  "enabled": true,
  "require_email_verification": true,
  "send_verification_email_on_sign_in": true,
  "send_verification_email_on_sign_up": true
}

defaultGeneral Error. The request may or may not be safe to retry, depending on the HTTP method, response status code, and whether a response was received. - If no response is returned from the API, a network error or timeout likely occurred. - In some cases, the request may have reached the server and been successfully processed, but the response failed to reach the client. As a result, retrying non-idempotent requests can lead to unintended results. The following HTTP methods are considered non-idempotent: `POST`, `PATCH`, `DELETE`, and `PUT`. Retrying these methods is generally **not safe**. The following methods are considered idempotent: `GET`, `HEAD`, and `OPTIONS`. Retrying these methods is **safe** in the event of a network error or timeout. Any request that returns a `503 Service Unavailable` response is always safe to retry. Any request that returns a `423 Locked` response is safe to retry. `423 Locked` indicates that the resource is temporarily locked, for example, due to another operation in progress. application/json

objectGeneralError

codestringrequired

default ""

messagestringrequired

Error message

request_idstring

Unique identifier for the request, useful for debugging. You can set this value manually by including an `X-Request-ID` header in the request. If not provided, the value will be generated automatically.

Example response

{
  "code": "",
  "message": "string",
  "request_id": "string"
}

Examples

project_idrequiredpath parameter

branch_idrequiredpath parameter

curl -X PATCH 'https://console.neon.tech/api/v2/projects/string/branches/string/auth/email_and_password' \
  -H 'Content-Type: application/json' \
  -d '{"auto_sign_in_after_verification":true,"disable_sign_up":true,"email_verification_method":"link","enabled":true,"require_email_verification":true,"send_verification_email_on_sign_in":true,"send_verification_email_on_sign_up":true}'

const response = await fetch('https://console.neon.tech/api/v2/projects/string/branches/string/auth/email_and_password', {
  method: 'PATCH',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"auto_sign_in_after_verification":true,"disable_sign_up":true,"email_verification_method":"link","enabled":true,"require_email_verification":true,"send_verification_email_on_sign_in":true,"send_verification_email_on_sign_up":true}),
});
const data = await response.json();

const response = await fetch('https://console.neon.tech/api/v2/projects/string/branches/string/auth/email_and_password', { method: 'PATCH', headers: { 'Content-Type': 'application/json' }, body: "{\"auto_sign_in_after_verification\":true,\"disable_sign_up\":true,\"email_verification_method\":\"link\",\"enabled\":true,\"require_email_verification\":true,\"send_verification_email_on_sign_in\":true,\"send_verification_email_on_sign_up\":true}" });
console.log(await response.json());

import requests

response = requests.request(
    "PATCH",
    "https://console.neon.tech/api/v2/projects/string/branches/string/auth/email_and_password",
    headers={"Content-Type": "application/json"},
    data='{"auto_sign_in_after_verification":true,"disable_sign_up":true,"email_verification_method":"link","enabled":true,"require_email_verification":true,"send_verification_email_on_sign_in":true,"send_verification_email_on_sign_up":true}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"auto_sign_in_after_verification":true,"disable_sign_up":true,"email_verification_method":"link","enabled":true,"require_email_verification":true,"send_verification_email_on_sign_in":true,"send_verification_email_on_sign_up":true}`)
	req, err := http.NewRequestWithContext(ctx, "PATCH", "https://console.neon.tech/api/v2/projects/string/branches/string/auth/email_and_password", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://console.neon.tech/api/v2/projects/string/branches/string/auth/email_and_password");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"auto_sign_in_after_verification\":true,\"disable_sign_up\":true,\"email_verification_method\":\"link\",\"enabled\":true,\"require_email_verification\":true,\"send_verification_email_on_sign_in\":true,\"send_verification_email_on_sign_up\":true}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://console.neon.tech/api/v2/projects/string/branches/string/auth/email_and_password"))
    .method("PATCH", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\"auto_sign_in_after_verification\":true,\"disable_sign_up\":true,\"email_verification_method\":\"link\",\"enabled\":true,\"require_email_verification\":true,\"send_verification_email_on_sign_in\":true,\"send_verification_email_on_sign_up\":true}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://console.neon.tech/api/v2/projects/string/branches/string/auth/email_and_password")
request = Net::HTTPGenericRequest.new("PATCH", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"auto_sign_in_after_verification\":true,\"disable_sign_up\":true,\"email_verification_method\":\"link\",\"enabled\":true,\"require_email_verification\":true,\"send_verification_email_on_sign_in\":true,\"send_verification_email_on_sign_up\":true}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Patch, "https://console.neon.tech/api/v2/projects/string/branches/string/auth/email_and_password");
request.Content = new StringContent("{\"auto_sign_in_after_verification\":true,\"disable_sign_up\":true,\"email_verification_method\":\"link\",\"enabled\":true,\"require_email_verification\":true,\"send_verification_email_on_sign_in\":true,\"send_verification_email_on_sign_up\":true}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "auto_sign_in_after_verification": true,
  "disable_sign_up": true,
  "email_verification_method": "link",
  "enabled": true,
  "require_email_verification": true,
  "send_verification_email_on_sign_in": true,
  "send_verification_email_on_sign_up": true
}

{
  "code": "",
  "message": "string",
  "request_id": "string"
}