v1

latestOpenAPI 3.0.02026-07-14169146300.3 KB

Auth

Updates a project's auth config

patch/v1/projects/{ref}/config/auth

Path parameters

refstring required

Example:abcdefghijklmnopqrst

Project ref

Request body

site_urlstring nullable

disable_signupboolean nullable

jwt_expinteger nullable

smtp_admin_emailstring email nullable

smtp_hoststring nullable

smtp_portstring nullable

smtp_userstring nullable

smtp_passstring nullable

smtp_max_frequencyinteger nullable

smtp_sender_namestring nullable

mailer_allow_unverified_email_sign_insboolean nullable

mailer_autoconfirmboolean nullable

mailer_subjects_invitestring nullable

mailer_subjects_confirmationstring nullable

mailer_subjects_recoverystring nullable

mailer_subjects_email_changestring nullable

mailer_subjects_magic_linkstring nullable

mailer_subjects_reauthenticationstring nullable

mailer_subjects_password_changed_notificationstring nullable

mailer_subjects_email_changed_notificationstring nullable

mailer_subjects_phone_changed_notificationstring nullable

mailer_subjects_mfa_factor_enrolled_notificationstring nullable

mailer_subjects_mfa_factor_unenrolled_notificationstring nullable

mailer_subjects_identity_linked_notificationstring nullable

mailer_subjects_identity_unlinked_notificationstring nullable

mailer_templates_invite_contentstring nullable

mailer_templates_confirmation_contentstring nullable

mailer_templates_recovery_contentstring nullable

mailer_templates_email_change_contentstring nullable

mailer_templates_magic_link_contentstring nullable

mailer_templates_reauthentication_contentstring nullable

mailer_templates_password_changed_notification_contentstring nullable

mailer_templates_email_changed_notification_contentstring nullable

mailer_templates_phone_changed_notification_contentstring nullable

mailer_templates_mfa_factor_enrolled_notification_contentstring nullable

mailer_templates_mfa_factor_unenrolled_notification_contentstring nullable

mailer_templates_identity_linked_notification_contentstring nullable

mailer_templates_identity_unlinked_notification_contentstring nullable

mailer_notifications_password_changed_enabledboolean nullable

mailer_notifications_email_changed_enabledboolean nullable

mailer_notifications_phone_changed_enabledboolean nullable

mailer_notifications_mfa_factor_enrolled_enabledboolean nullable

mailer_notifications_mfa_factor_unenrolled_enabledboolean nullable

mailer_notifications_identity_linked_enabledboolean nullable

mailer_notifications_identity_unlinked_enabledboolean nullable

mfa_max_enrolled_factorsinteger nullable

uri_allow_liststring nullable

external_anonymous_users_enabledboolean nullable

external_email_enabledboolean nullable

external_phone_enabledboolean nullable

saml_enabledboolean nullable

saml_external_urlstring nullable

security_sb_forwarded_for_enabledboolean nullable

security_captcha_enabledboolean nullable

security_captcha_provider'turnstile' | 'hcaptcha' nullable

security_captcha_secretstring nullable

sessions_timeboxnumber nullable

sessions_inactivity_timeoutnumber nullable

sessions_single_per_userboolean nullable

sessions_tagsstring nullable

rate_limit_anonymous_usersinteger nullable

rate_limit_email_sentinteger nullable

rate_limit_sms_sentinteger nullable

rate_limit_verifyinteger nullable

rate_limit_token_refreshinteger nullable

rate_limit_otpinteger nullable

rate_limit_web3integer nullable

mailer_secure_email_change_enabledboolean nullable

refresh_token_rotation_enabledboolean nullable

password_hibp_enabledboolean nullable

password_min_lengthinteger nullable

password_required_characters'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ:0123456789' | 'abcdefghijklmnopqrstuvwxyz:ABCDEFGHIJKLMNOPQRSTUVWXYZ:0123456789' | 'abcdefghijklmnopqrstuvwxyz:ABCDEFGHIJKLMNOPQRSTUVWXYZ:0123456789:!@#$%^&*()_+-=[]{};'\\:"|<>?,./`~' | '' nullable

security_manual_linking_enabledboolean nullable

security_update_password_require_reauthenticationboolean nullable

security_refresh_token_reuse_intervalinteger nullable

mailer_otp_expinteger

mailer_otp_lengthinteger nullable

sms_autoconfirmboolean nullable

sms_max_frequencyinteger nullable

sms_otp_expinteger nullable

sms_otp_lengthinteger

sms_provider'messagebird' | 'textlocal' | 'twilio' | 'twilio_verify' | 'vonage' nullable

sms_messagebird_access_keystring nullable

sms_messagebird_originatorstring nullable

sms_test_otpstring nullable

sms_test_otp_valid_untilstring date-time nullable

sms_textlocal_api_keystring nullable

sms_textlocal_senderstring nullable

sms_twilio_account_sidstring nullable

sms_twilio_auth_tokenstring nullable

sms_twilio_content_sidstring nullable

sms_twilio_message_service_sidstring nullable

sms_twilio_verify_account_sidstring nullable

sms_twilio_verify_auth_tokenstring nullable

sms_twilio_verify_message_service_sidstring nullable

sms_vonage_api_keystring nullable

sms_vonage_api_secretstring nullable

sms_vonage_fromstring nullable

sms_templatestring nullable

hook_mfa_verification_attempt_enabledboolean nullable

hook_mfa_verification_attempt_uristring nullable

hook_mfa_verification_attempt_secretsstring nullable

hook_password_verification_attempt_enabledboolean nullable

hook_password_verification_attempt_uristring nullable

hook_password_verification_attempt_secretsstring nullable

hook_custom_access_token_enabledboolean nullable

hook_custom_access_token_uristring nullable

hook_custom_access_token_secretsstring nullable

hook_send_sms_enabledboolean nullable

hook_send_sms_uristring nullable

hook_send_sms_secretsstring nullable

hook_send_email_enabledboolean nullable

hook_send_email_uristring nullable

hook_send_email_secretsstring nullable

hook_before_user_created_enabledboolean nullable

hook_before_user_created_uristring nullable

hook_before_user_created_secretsstring nullable

hook_after_user_created_enabledboolean nullable

hook_after_user_created_uristring nullable

hook_after_user_created_secretsstring nullable

external_apple_enabledboolean nullable

external_apple_client_idstring nullable

external_apple_email_optionalboolean nullable

external_apple_secretstring nullable

external_apple_additional_client_idsstring nullable

external_azure_enabledboolean nullable

external_azure_client_idstring nullable

external_azure_email_optionalboolean nullable

external_azure_secretstring nullable

external_azure_urlstring nullable

external_bitbucket_enabledboolean nullable

external_bitbucket_client_idstring nullable

external_bitbucket_email_optionalboolean nullable

external_bitbucket_secretstring nullable

external_discord_enabledboolean nullable

external_discord_client_idstring nullable

external_discord_email_optionalboolean nullable

external_discord_secretstring nullable

external_facebook_enabledboolean nullable

external_facebook_client_idstring nullable

external_facebook_email_optionalboolean nullable

external_facebook_secretstring nullable

external_figma_enabledboolean nullable

external_figma_client_idstring nullable

external_figma_email_optionalboolean nullable

external_figma_secretstring nullable

external_github_enabledboolean nullable

external_github_client_idstring nullable

external_github_email_optionalboolean nullable

external_github_secretstring nullable

external_gitlab_enabledboolean nullable

external_gitlab_client_idstring nullable

external_gitlab_email_optionalboolean nullable

external_gitlab_secretstring nullable

external_gitlab_urlstring nullable

external_google_enabledboolean nullable

external_google_client_idstring nullable

external_google_email_optionalboolean nullable

external_google_secretstring nullable

external_google_additional_client_idsstring nullable

external_google_skip_nonce_checkboolean nullable

external_kakao_enabledboolean nullable

external_kakao_client_idstring nullable

external_kakao_email_optionalboolean nullable

external_kakao_secretstring nullable

external_keycloak_enabledboolean nullable

external_keycloak_client_idstring nullable

external_keycloak_email_optionalboolean nullable

external_keycloak_secretstring nullable

external_keycloak_urlstring nullable

external_linkedin_oidc_enabledboolean nullable

external_linkedin_oidc_client_idstring nullable

external_linkedin_oidc_email_optionalboolean nullable

external_linkedin_oidc_secretstring nullable

external_slack_oidc_enabledboolean nullable

external_slack_oidc_client_idstring nullable

external_slack_oidc_email_optionalboolean nullable

external_slack_oidc_secretstring nullable

external_notion_enabledboolean nullable

external_notion_client_idstring nullable

external_notion_email_optionalboolean nullable

external_notion_secretstring nullable

external_slack_enabledboolean nullable

external_slack_client_idstring nullable

external_slack_email_optionalboolean nullable

external_slack_secretstring nullable

external_spotify_enabledboolean nullable

external_spotify_client_idstring nullable

external_spotify_email_optionalboolean nullable

external_spotify_secretstring nullable

external_twitch_enabledboolean nullable

external_twitch_client_idstring nullable

external_twitch_email_optionalboolean nullable

external_twitch_secretstring nullable

external_twitter_enabledboolean nullable

external_twitter_client_idstring nullable

external_twitter_email_optionalboolean nullable

external_twitter_secretstring nullable

external_x_enabledboolean nullable

external_x_client_idstring nullable

external_x_email_optionalboolean nullable

external_x_secretstring nullable

external_workos_enabledboolean nullable

external_workos_client_idstring nullable

external_workos_secretstring nullable

external_workos_urlstring nullable

external_web3_solana_enabledboolean nullable

external_web3_ethereum_enabledboolean nullable

external_zoom_enabledboolean nullable

external_zoom_client_idstring nullable

external_zoom_email_optionalboolean nullable

external_zoom_secretstring nullable

db_max_pool_sizeinteger nullable

db_max_pool_size_unit'connections' | 'percent' nullable

api_max_request_durationinteger nullable

mfa_totp_enroll_enabledboolean nullable

mfa_totp_verify_enabledboolean nullable

mfa_web_authn_enroll_enabledboolean nullable

mfa_web_authn_verify_enabledboolean nullable

passkey_enabledboolean

webauthn_rp_display_namestring nullable

webauthn_rp_idstring nullable

webauthn_rp_originsstring nullable

mfa_phone_enroll_enabledboolean nullable

mfa_phone_verify_enabledboolean nullable

mfa_phone_max_frequencyinteger nullable

mfa_phone_otp_lengthinteger nullable

mfa_phone_templatestring nullable

nimbus_oauth_client_idstring nullable

nimbus_oauth_client_secretstring nullable

oauth_server_enabledboolean nullable

oauth_server_allow_dynamic_registrationboolean nullable

oauth_server_authorization_pathstring nullable

custom_oauth_enabledboolean

Example request

{
  "site_url": "https://app.example.com",
  "disable_signup": false,
  "jwt_exp": 3600
}

Response

api_max_request_durationinteger nullable required

db_max_pool_sizeinteger nullable required

db_max_pool_size_unit'connections' | 'percent' nullable required

disable_signupboolean nullable required

external_anonymous_users_enabledboolean nullable required

external_apple_additional_client_idsstring nullable required

external_apple_client_idstring nullable required

external_apple_email_optionalboolean nullable required

external_apple_enabledboolean nullable required

external_apple_secretstring nullable required

external_azure_client_idstring nullable required

external_azure_email_optionalboolean nullable required

external_azure_enabledboolean nullable required

external_azure_secretstring nullable required

external_azure_urlstring nullable required

external_bitbucket_client_idstring nullable required

external_bitbucket_email_optionalboolean nullable required

external_bitbucket_enabledboolean nullable required

external_bitbucket_secretstring nullable required

external_discord_client_idstring nullable required

external_discord_email_optionalboolean nullable required

external_discord_enabledboolean nullable required

external_discord_secretstring nullable required

external_email_enabledboolean nullable required

external_facebook_client_idstring nullable required

external_facebook_email_optionalboolean nullable required

external_facebook_enabledboolean nullable required

external_facebook_secretstring nullable required

external_figma_client_idstring nullable required

external_figma_email_optionalboolean nullable required

external_figma_enabledboolean nullable required

external_figma_secretstring nullable required

external_github_client_idstring nullable required

external_github_email_optionalboolean nullable required

external_github_enabledboolean nullable required

external_github_secretstring nullable required

external_gitlab_client_idstring nullable required

external_gitlab_email_optionalboolean nullable required

external_gitlab_enabledboolean nullable required

external_gitlab_secretstring nullable required

external_gitlab_urlstring nullable required

external_google_additional_client_idsstring nullable required

external_google_client_idstring nullable required

external_google_email_optionalboolean nullable required

external_google_enabledboolean nullable required

external_google_secretstring nullable required

external_google_skip_nonce_checkboolean nullable required

external_kakao_client_idstring nullable required

external_kakao_email_optionalboolean nullable required

external_kakao_enabledboolean nullable required

external_kakao_secretstring nullable required

external_keycloak_client_idstring nullable required

external_keycloak_email_optionalboolean nullable required

external_keycloak_enabledboolean nullable required

external_keycloak_secretstring nullable required

external_keycloak_urlstring nullable required

external_linkedin_oidc_client_idstring nullable required

external_linkedin_oidc_email_optionalboolean nullable required

external_linkedin_oidc_enabledboolean nullable required

external_linkedin_oidc_secretstring nullable required

external_slack_oidc_client_idstring nullable required

external_slack_oidc_email_optionalboolean nullable required

external_slack_oidc_enabledboolean nullable required

external_slack_oidc_secretstring nullable required

external_notion_client_idstring nullable required

external_notion_email_optionalboolean nullable required

external_notion_enabledboolean nullable required

external_notion_secretstring nullable required

external_phone_enabledboolean nullable required

external_slack_client_idstring nullable required

external_slack_email_optionalboolean nullable required

external_slack_enabledboolean nullable required

external_slack_secretstring nullable required

external_spotify_client_idstring nullable required

external_spotify_email_optionalboolean nullable required

external_spotify_enabledboolean nullable required

external_spotify_secretstring nullable required

external_twitch_client_idstring nullable required

external_twitch_email_optionalboolean nullable required

external_twitch_enabledboolean nullable required

external_twitch_secretstring nullable required

external_twitter_client_idstring nullable required

external_twitter_email_optionalboolean nullable required

external_twitter_enabledboolean nullable required

external_twitter_secretstring nullable required

external_x_client_idstring nullable required

external_x_email_optionalboolean nullable required

external_x_enabledboolean nullable required

external_x_secretstring nullable required

external_workos_client_idstring nullable required

external_workos_enabledboolean nullable required

external_workos_secretstring nullable required

external_workos_urlstring nullable required

external_web3_solana_enabledboolean nullable required

external_web3_ethereum_enabledboolean nullable required

external_zoom_client_idstring nullable required

external_zoom_email_optionalboolean nullable required

external_zoom_enabledboolean nullable required

external_zoom_secretstring nullable required

hook_custom_access_token_enabledboolean nullable required

hook_custom_access_token_uristring nullable required

hook_custom_access_token_secretsstring nullable required

hook_mfa_verification_attempt_enabledboolean nullable required

hook_mfa_verification_attempt_uristring nullable required

hook_mfa_verification_attempt_secretsstring nullable required

hook_password_verification_attempt_enabledboolean nullable required

hook_password_verification_attempt_uristring nullable required

hook_password_verification_attempt_secretsstring nullable required

hook_send_sms_enabledboolean nullable required

hook_send_sms_uristring nullable required

hook_send_sms_secretsstring nullable required

hook_send_email_enabledboolean nullable required

hook_send_email_uristring nullable required

hook_send_email_secretsstring nullable required

hook_before_user_created_enabledboolean nullable required

hook_before_user_created_uristring nullable required

hook_before_user_created_secretsstring nullable required

hook_after_user_created_enabledboolean nullable required

hook_after_user_created_uristring nullable required

hook_after_user_created_secretsstring nullable required

jwt_expinteger nullable required

mailer_allow_unverified_email_sign_insboolean nullable required

mailer_autoconfirmboolean nullable required

mailer_otp_expinteger required

mailer_otp_lengthinteger nullable required

mailer_secure_email_change_enabledboolean nullable required

mailer_subjects_confirmationstring nullable required

mailer_subjects_email_changestring nullable required

mailer_subjects_invitestring nullable required

mailer_subjects_magic_linkstring nullable required

mailer_subjects_reauthenticationstring nullable required

mailer_subjects_recoverystring nullable required

mailer_subjects_password_changed_notificationstring nullable required

mailer_subjects_email_changed_notificationstring nullable required

mailer_subjects_phone_changed_notificationstring nullable required

mailer_subjects_mfa_factor_enrolled_notificationstring nullable required

mailer_subjects_mfa_factor_unenrolled_notificationstring nullable required

mailer_subjects_identity_linked_notificationstring nullable required

mailer_subjects_identity_unlinked_notificationstring nullable required

mailer_templates_confirmation_contentstring nullable required

mailer_templates_email_change_contentstring nullable required

mailer_templates_invite_contentstring nullable required

mailer_templates_magic_link_contentstring nullable required

mailer_templates_reauthentication_contentstring nullable required

mailer_templates_recovery_contentstring nullable required

mailer_templates_password_changed_notification_contentstring nullable required

mailer_templates_email_changed_notification_contentstring nullable required

mailer_templates_phone_changed_notification_contentstring nullable required

mailer_templates_mfa_factor_enrolled_notification_contentstring nullable required

mailer_templates_mfa_factor_unenrolled_notification_contentstring nullable required

mailer_templates_identity_linked_notification_contentstring nullable required

mailer_templates_identity_unlinked_notification_contentstring nullable required

mailer_notifications_password_changed_enabledboolean nullable required

mailer_notifications_email_changed_enabledboolean nullable required

mailer_notifications_phone_changed_enabledboolean nullable required

mailer_notifications_mfa_factor_enrolled_enabledboolean nullable required

mailer_notifications_mfa_factor_unenrolled_enabledboolean nullable required

mailer_notifications_identity_linked_enabledboolean nullable required

mailer_notifications_identity_unlinked_enabledboolean nullable required

mfa_max_enrolled_factorsinteger nullable required

mfa_totp_enroll_enabledboolean nullable required

mfa_totp_verify_enabledboolean nullable required

mfa_phone_enroll_enabledboolean nullable required

mfa_phone_verify_enabledboolean nullable required

mfa_web_authn_enroll_enabledboolean nullable required

mfa_web_authn_verify_enabledboolean nullable required

passkey_enabledboolean required

webauthn_rp_display_namestring nullable required

webauthn_rp_idstring nullable required

webauthn_rp_originsstring nullable required

mfa_phone_otp_lengthinteger required

mfa_phone_templatestring nullable required

mfa_phone_max_frequencyinteger nullable required

nimbus_oauth_client_idstring nullable required

nimbus_oauth_email_optionalboolean nullable required

nimbus_oauth_client_secretstring nullable required

password_hibp_enabledboolean nullable required

password_min_lengthinteger nullable required

rate_limit_anonymous_usersinteger nullable required

rate_limit_email_sentinteger nullable required

rate_limit_sms_sentinteger nullable required

rate_limit_token_refreshinteger nullable required

rate_limit_verifyinteger nullable required

rate_limit_otpinteger nullable required

rate_limit_web3integer nullable required

refresh_token_rotation_enabledboolean nullable required

saml_enabledboolean nullable required

saml_external_urlstring nullable required

saml_allow_encrypted_assertionsboolean nullable required

security_sb_forwarded_for_enabledboolean nullable required

security_captcha_enabledboolean nullable required

security_captcha_provider'turnstile' | 'hcaptcha' nullable required

security_captcha_secretstring nullable required

security_manual_linking_enabledboolean nullable required

security_refresh_token_reuse_intervalinteger nullable required

security_update_password_require_reauthenticationboolean nullable required

sessions_inactivity_timeoutnumber nullable required

sessions_single_per_userboolean nullable required

sessions_tagsstring nullable required

sessions_timeboxnumber nullable required

site_urlstring nullable required

sms_autoconfirmboolean nullable required

sms_max_frequencyinteger nullable required

sms_messagebird_access_keystring nullable required

sms_messagebird_originatorstring nullable required

sms_otp_expinteger nullable required

sms_otp_lengthinteger required

sms_provider'messagebird' | 'textlocal' | 'twilio' | 'twilio_verify' | 'vonage' nullable required

sms_templatestring nullable required

sms_test_otpstring nullable required

sms_test_otp_valid_untilstring date-time nullable required

sms_textlocal_api_keystring nullable required

sms_textlocal_senderstring nullable required

sms_twilio_account_sidstring nullable required

sms_twilio_auth_tokenstring nullable required

sms_twilio_content_sidstring nullable required

sms_twilio_message_service_sidstring nullable required

sms_twilio_verify_account_sidstring nullable required

sms_twilio_verify_auth_tokenstring nullable required

sms_twilio_verify_message_service_sidstring nullable required

sms_vonage_api_keystring nullable required

sms_vonage_api_secretstring nullable required

sms_vonage_fromstring nullable required

smtp_admin_emailstring email nullable required

smtp_hoststring nullable required

smtp_max_frequencyinteger nullable required

smtp_passstring nullable required

smtp_portstring nullable required

smtp_sender_namestring nullable required

smtp_userstring nullable required

uri_allow_liststring nullable required

oauth_server_enabledboolean required

oauth_server_allow_dynamic_registrationboolean required

oauth_server_authorization_pathstring nullable required

custom_oauth_enabledboolean required

custom_oauth_max_providersinteger required