Skip to main content
PATCH
/
settings
/
auth
Update Auth Settings
curl --request PATCH \
  --url https://api.example.com/settings/auth \
  --header 'Content-Type: application/json' \
  --cookie fastapiusersauth= \
  --data '
{
  "auth_basic_enabled": true,
  "auth_require_email_verification": false,
  "auth_allowed_email_domains": [
    "<string>"
  ],
  "auth_min_password_length": 12,
  "auth_session_expire_time_seconds": 604800
}
'
{}

Authorizations

​
fastapiusersauth
string
cookie
required

Body

application/json
​
auth_basic_enabled
boolean
default:true

Whether basic auth is enabled.

​
auth_require_email_verification
boolean
default:false

Whether email verification is required for authentication.

​
auth_allowed_email_domains
string[]

Allowed email domains for authentication. If empty, all domains are allowed.

​
auth_min_password_length
integer
default:12

Minimum password length for authentication.

​
auth_session_expire_time_seconds
integer
default:604800

Session expiration time in seconds.

Response

Successful Response