Skip to content
Management API Reference

Updates a project's auth config

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

OAuth scopes

  • auth:write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • site_url
    Optional
    string
  • disable_signup
    Optional
    boolean
  • jwt_exp
    Optional
    integer
  • smtp_admin_email
    Optional
    string
  • smtp_host
    Optional
    string
  • smtp_port
    Optional
    string
  • smtp_user
    Optional
    string
  • smtp_pass
    Optional
    string
  • smtp_max_frequency
    Optional
    integer
  • smtp_sender_name
    Optional
    string
  • mailer_allow_unverified_email_sign_ins
    Optional
    boolean
  • mailer_autoconfirm
    Optional
    boolean
  • mailer_subjects_invite
    Optional
    string
  • mailer_subjects_confirmation
    Optional
    string
  • mailer_subjects_recovery
    Optional
    string
  • mailer_subjects_email_change
    Optional
    string
  • mailer_subjects_magic_link
    Optional
    string
  • mailer_subjects_reauthentication
    Optional
    string
  • mailer_subjects_password_changed_notification
    Optional
    string
  • mailer_subjects_email_changed_notification
    Optional
    string
  • mailer_subjects_phone_changed_notification
    Optional
    string
  • mailer_subjects_mfa_factor_enrolled_notification
    Optional
    string
  • mailer_subjects_mfa_factor_unenrolled_notification
    Optional
    string
  • mailer_subjects_identity_linked_notification
    Optional
    string
  • mailer_subjects_identity_unlinked_notification
    Optional
    string
  • mailer_templates_invite_content
    Optional
    string
  • mailer_templates_confirmation_content
    Optional
    string
  • mailer_templates_recovery_content
    Optional
    string
  • mailer_templates_email_change_content
    Optional
    string
  • mailer_templates_magic_link_content
    Optional
    string
  • mailer_templates_reauthentication_content
    Optional
    string
  • mailer_templates_password_changed_notification_content
    Optional
    string
  • mailer_templates_email_changed_notification_content
    Optional
    string
  • mailer_templates_phone_changed_notification_content
    Optional
    string
  • mailer_templates_mfa_factor_enrolled_notification_content
    Optional
    string
  • mailer_templates_mfa_factor_unenrolled_notification_content
    Optional
    string
  • mailer_templates_identity_linked_notification_content
    Optional
    string
  • mailer_templates_identity_unlinked_notification_content
    Optional
    string
  • mailer_notifications_password_changed_enabled
    Optional
    boolean
  • mailer_notifications_email_changed_enabled
    Optional
    boolean
  • mailer_notifications_phone_changed_enabled
    Optional
    boolean
  • mailer_notifications_mfa_factor_enrolled_enabled
    Optional
    boolean
  • mailer_notifications_mfa_factor_unenrolled_enabled
    Optional
    boolean
  • mailer_notifications_identity_linked_enabled
    Optional
    boolean
  • mailer_notifications_identity_unlinked_enabled
    Optional
    boolean
  • mfa_max_enrolled_factors
    Optional
    integer
  • uri_allow_list
    Optional
    string
  • external_anonymous_users_enabled
    Optional
    boolean
  • external_email_enabled
    Optional
    boolean
  • external_phone_enabled
    Optional
    boolean
  • saml_enabled
    Optional
    boolean
  • saml_external_url
    Optional
    string
  • security_sb_forwarded_for_enabled
    Optional
    boolean
  • security_captcha_enabled
    Optional
    boolean
  • security_captcha_provider
    Optional
    enum
  • security_captcha_secret
    Optional
    string
  • sessions_timebox
    Optional
    number
  • sessions_inactivity_timeout
    Optional
    number
  • sessions_single_per_user
    Optional
    boolean
  • sessions_tags
    Optional
    string
  • rate_limit_anonymous_users
    Optional
    integer
  • rate_limit_email_sent
    Optional
    integer
  • rate_limit_sms_sent
    Optional
    integer
  • rate_limit_verify
    Optional
    integer
  • rate_limit_token_refresh
    Optional
    integer
  • rate_limit_otp
    Optional
    integer
  • rate_limit_web3
    Optional
    integer
  • mailer_secure_email_change_enabled
    Optional
    boolean
  • refresh_token_rotation_enabled
    Optional
    boolean
  • password_hibp_enabled
    Optional
    boolean
  • password_min_length
    Optional
    integer
  • password_required_characters
    Optional
    enum
  • security_manual_linking_enabled
    Optional
    boolean
  • security_update_password_require_reauthentication
    Optional
    boolean
  • security_refresh_token_reuse_interval
    Optional
    integer
  • mailer_otp_exp
    Optional
    integer
  • mailer_otp_length
    Optional
    integer
  • sms_autoconfirm
    Optional
    boolean
  • sms_max_frequency
    Optional
    integer
  • sms_otp_exp
    Optional
    integer
  • sms_otp_length
    Optional
    integer
  • sms_provider
    Optional
    enum
  • sms_messagebird_access_key
    Optional
    string
  • sms_messagebird_originator
    Optional
    string
  • sms_test_otp
    Optional
    string
  • sms_test_otp_valid_until
    Optional
    string
  • sms_textlocal_api_key
    Optional
    string
  • sms_textlocal_sender
    Optional
    string
  • sms_twilio_account_sid
    Optional
    string
  • sms_twilio_auth_token
    Optional
    string
  • sms_twilio_content_sid
    Optional
    string
  • sms_twilio_message_service_sid
    Optional
    string
  • sms_twilio_verify_account_sid
    Optional
    string
  • sms_twilio_verify_auth_token
    Optional
    string
  • sms_twilio_verify_message_service_sid
    Optional
    string
  • sms_vonage_api_key
    Optional
    string
  • sms_vonage_api_secret
    Optional
    string
  • sms_vonage_from
    Optional
    string
  • sms_template
    Optional
    string
  • hook_mfa_verification_attempt_enabled
    Optional
    boolean
  • hook_mfa_verification_attempt_uri
    Optional
    string
  • hook_mfa_verification_attempt_secrets
    Optional
    string
  • hook_password_verification_attempt_enabled
    Optional
    boolean
  • hook_password_verification_attempt_uri
    Optional
    string
  • hook_password_verification_attempt_secrets
    Optional
    string
  • hook_custom_access_token_enabled
    Optional
    boolean
  • hook_custom_access_token_uri
    Optional
    string
  • hook_custom_access_token_secrets
    Optional
    string
  • hook_send_sms_enabled
    Optional
    boolean
  • hook_send_sms_uri
    Optional
    string
  • hook_send_sms_secrets
    Optional
    string
  • hook_send_email_enabled
    Optional
    boolean
  • hook_send_email_uri
    Optional
    string
  • hook_send_email_secrets
    Optional
    string
  • hook_before_user_created_enabled
    Optional
    boolean
  • hook_before_user_created_uri
    Optional
    string
  • hook_before_user_created_secrets
    Optional
    string
  • hook_after_user_created_enabled
    Optional
    boolean
  • hook_after_user_created_uri
    Optional
    string
  • hook_after_user_created_secrets
    Optional
    string
  • external_apple_enabled
    Optional
    boolean
  • external_apple_client_id
    Optional
    string
  • external_apple_email_optional
    Optional
    boolean
  • external_apple_secret
    Optional
    string
  • external_apple_additional_client_ids
    Optional
    string
  • external_azure_enabled
    Optional
    boolean
  • external_azure_client_id
    Optional
    string
  • external_azure_email_optional
    Optional
    boolean
  • external_azure_secret
    Optional
    string
  • external_azure_url
    Optional
    string
  • external_bitbucket_enabled
    Optional
    boolean
  • external_bitbucket_client_id
    Optional
    string
  • external_bitbucket_email_optional
    Optional
    boolean
  • external_bitbucket_secret
    Optional
    string
  • external_discord_enabled
    Optional
    boolean
  • external_discord_client_id
    Optional
    string
  • external_discord_email_optional
    Optional
    boolean
  • external_discord_secret
    Optional
    string
  • external_facebook_enabled
    Optional
    boolean
  • external_facebook_client_id
    Optional
    string
  • external_facebook_email_optional
    Optional
    boolean
  • external_facebook_secret
    Optional
    string
  • external_figma_enabled
    Optional
    boolean
  • external_figma_client_id
    Optional
    string
  • external_figma_email_optional
    Optional
    boolean
  • external_figma_secret
    Optional
    string
  • external_github_enabled
    Optional
    boolean
  • external_github_client_id
    Optional
    string
  • external_github_email_optional
    Optional
    boolean
  • external_github_secret
    Optional
    string
  • external_gitlab_enabled
    Optional
    boolean
  • external_gitlab_client_id
    Optional
    string
  • external_gitlab_email_optional
    Optional
    boolean
  • external_gitlab_secret
    Optional
    string
  • external_gitlab_url
    Optional
    string
  • external_google_enabled
    Optional
    boolean
  • external_google_client_id
    Optional
    string
  • external_google_email_optional
    Optional
    boolean
  • external_google_secret
    Optional
    string
  • external_google_additional_client_ids
    Optional
    string
  • external_google_skip_nonce_check
    Optional
    boolean
  • external_kakao_enabled
    Optional
    boolean
  • external_kakao_client_id
    Optional
    string
  • external_kakao_email_optional
    Optional
    boolean
  • external_kakao_secret
    Optional
    string
  • external_keycloak_enabled
    Optional
    boolean
  • external_keycloak_client_id
    Optional
    string
  • external_keycloak_email_optional
    Optional
    boolean
  • external_keycloak_secret
    Optional
    string
  • external_keycloak_url
    Optional
    string
  • external_linkedin_oidc_enabled
    Optional
    boolean
  • external_linkedin_oidc_client_id
    Optional
    string
  • external_linkedin_oidc_email_optional
    Optional
    boolean
  • external_linkedin_oidc_secret
    Optional
    string
  • external_slack_oidc_enabled
    Optional
    boolean
  • external_slack_oidc_client_id
    Optional
    string
  • external_slack_oidc_email_optional
    Optional
    boolean
  • external_slack_oidc_secret
    Optional
    string
  • external_notion_enabled
    Optional
    boolean
  • external_notion_client_id
    Optional
    string
  • external_notion_email_optional
    Optional
    boolean
  • external_notion_secret
    Optional
    string
  • external_slack_enabled
    Optional
    boolean
  • external_slack_client_id
    Optional
    string
  • external_slack_email_optional
    Optional
    boolean
  • external_slack_secret
    Optional
    string
  • external_spotify_enabled
    Optional
    boolean
  • external_spotify_client_id
    Optional
    string
  • external_spotify_email_optional
    Optional
    boolean
  • external_spotify_secret
    Optional
    string
  • external_twitch_enabled
    Optional
    boolean
  • external_twitch_client_id
    Optional
    string
  • external_twitch_email_optional
    Optional
    boolean
  • external_twitch_secret
    Optional
    string
  • external_twitter_enabled
    Optional
    boolean
  • external_twitter_client_id
    Optional
    string
  • external_twitter_email_optional
    Optional
    boolean
  • external_twitter_secret
    Optional
    string
  • external_x_enabled
    Optional
    boolean
  • external_x_client_id
    Optional
    string
  • external_x_email_optional
    Optional
    boolean
  • external_x_secret
    Optional
    string
  • external_workos_enabled
    Optional
    boolean
  • external_workos_client_id
    Optional
    string
  • external_workos_secret
    Optional
    string
  • external_workos_url
    Optional
    string
  • external_web3_solana_enabled
    Optional
    boolean
  • external_web3_ethereum_enabled
    Optional
    boolean
  • external_zoom_enabled
    Optional
    boolean
  • external_zoom_client_id
    Optional
    string
  • external_zoom_email_optional
    Optional
    boolean
  • external_zoom_secret
    Optional
    string
  • db_max_pool_size
    Optional
    integer
  • db_max_pool_size_unit
    Optional
    enum
  • api_max_request_duration
    Optional
    integer
  • mfa_totp_enroll_enabled
    Optional
    boolean
  • mfa_totp_verify_enabled
    Optional
    boolean
  • mfa_web_authn_enroll_enabled
    Optional
    boolean
  • mfa_web_authn_verify_enabled
    Optional
    boolean
  • passkey_enabled
    Optional
    boolean
  • webauthn_rp_display_name
    Optional
    string
  • webauthn_rp_id
    Optional
    string
  • webauthn_rp_origins
    Optional
    string
  • mfa_phone_enroll_enabled
    Optional
    boolean
  • mfa_phone_verify_enabled
    Optional
    boolean
  • mfa_phone_max_frequency
    Optional
    integer
  • mfa_phone_otp_length
    Optional
    integer
  • mfa_phone_template
    Optional
    string
  • nimbus_oauth_client_id
    Optional
    string
  • nimbus_oauth_client_secret
    Optional
    string
  • oauth_server_enabled
    Optional
    boolean
  • oauth_server_allow_dynamic_registration
    Optional
    boolean
  • oauth_server_authorization_path
    Optional
    string
  • custom_oauth_enabled
    Optional
    boolean

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Response (200)

1
{
2
"api_max_request_duration": 42,
3
"db_max_pool_size": 42,
4
"db_max_pool_size_unit": "connections",
5
"disable_signup": true,
6
"external_anonymous_users_enabled": true,
7
"external_apple_additional_client_ids": "lorem",
8
"external_apple_client_id": "lorem",
9
"external_apple_email_optional": true,
10
"external_apple_enabled": true,
11
"external_apple_secret": "lorem",
12
"external_azure_client_id": "lorem",
13
"external_azure_email_optional": true,
14
"external_azure_enabled": true,
15
"external_azure_secret": "lorem",
16
"external_azure_url": "lorem",
17
"external_bitbucket_client_id": "lorem",
18
"external_bitbucket_email_optional": true,
19
"external_bitbucket_enabled": true,
20
"external_bitbucket_secret": "lorem",
21
"external_discord_client_id": "lorem",
22
"external_discord_email_optional": true,
23
"external_discord_enabled": true,
24
"external_discord_secret": "lorem",
25
"external_email_enabled": true,
26
"external_facebook_client_id": "lorem",
27
"external_facebook_email_optional": true,
28
"external_facebook_enabled": true,
29
"external_facebook_secret": "lorem",
30
"external_figma_client_id": "lorem",
31
"external_figma_email_optional": true,
32
"external_figma_enabled": true,
33
"external_figma_secret": "lorem",
34
"external_github_client_id": "lorem",
35
"external_github_email_optional": true,
36
"external_github_enabled": true,
37
"external_github_secret": "lorem",
38
"external_gitlab_client_id": "lorem",
39
"external_gitlab_email_optional": true,
40
"external_gitlab_enabled": true,
41
"external_gitlab_secret": "lorem",
42
"external_gitlab_url": "lorem",
43
"external_google_additional_client_ids": "lorem",
44
"external_google_client_id": "lorem",
45
"external_google_email_optional": true,
46
"external_google_enabled": true,
47
"external_google_secret": "lorem",
48
"external_google_skip_nonce_check": true,
49
"external_kakao_client_id": "lorem",
50
"external_kakao_email_optional": true,
51
"external_kakao_enabled": true,
52
"external_kakao_secret": "lorem",
53
"external_keycloak_client_id": "lorem",
54
"external_keycloak_email_optional": true,
55
"external_keycloak_enabled": true,
56
"external_keycloak_secret": "lorem",
57
"external_keycloak_url": "lorem",
58
"external_linkedin_oidc_client_id": "lorem",
59
"external_linkedin_oidc_email_optional": true,
60
"external_linkedin_oidc_enabled": true,
61
"external_linkedin_oidc_secret": "lorem",
62
"external_slack_oidc_client_id": "lorem",
63
"external_slack_oidc_email_optional": true,
64
"external_slack_oidc_enabled": true,
65
"external_slack_oidc_secret": "lorem",
66
"external_notion_client_id": "lorem",
67
"external_notion_email_optional": true,
68
"external_notion_enabled": true,
69
"external_notion_secret": "lorem",
70
"external_phone_enabled": true,
71
"external_slack_client_id": "lorem",
72
"external_slack_email_optional": true,
73
"external_slack_enabled": true,
74
"external_slack_secret": "lorem",
75
"external_spotify_client_id": "lorem",
76
"external_spotify_email_optional": true,
77
"external_spotify_enabled": true,
78
"external_spotify_secret": "lorem",
79
"external_twitch_client_id": "lorem",
80
"external_twitch_email_optional": true,
81
"external_twitch_enabled": true,
82
"external_twitch_secret": "lorem",
83
"external_twitter_client_id": "lorem",
84
"external_twitter_email_optional": true,
85
"external_twitter_enabled": true,
86
"external_twitter_secret": "lorem",
87
"external_x_client_id": "lorem",
88
"external_x_email_optional": true,
89
"external_x_enabled": true,
90
"external_x_secret": "lorem",
91
"external_workos_client_id": "lorem",
92
"external_workos_enabled": true,
93
"external_workos_secret": "lorem",
94
"external_workos_url": "lorem",
95
"external_web3_solana_enabled": true,
96
"external_web3_ethereum_enabled": true,
97
"external_zoom_client_id": "lorem",
98
"external_zoom_email_optional": true,
99
"external_zoom_enabled": true,
100
"external_zoom_secret": "lorem",
101
"hook_custom_access_token_enabled": true,
102
"hook_custom_access_token_uri": "lorem",
103
"hook_custom_access_token_secrets": "lorem",
104
"hook_mfa_verification_attempt_enabled": true,
105
"hook_mfa_verification_attempt_uri": "lorem",
106
"hook_mfa_verification_attempt_secrets": "lorem",
107
"hook_password_verification_attempt_enabled": true,
108
"hook_password_verification_attempt_uri": "lorem",
109
"hook_password_verification_attempt_secrets": "lorem",
110
"hook_send_sms_enabled": true,
111
"hook_send_sms_uri": "lorem",
112
"hook_send_sms_secrets": "lorem",
113
"hook_send_email_enabled": true,
114
"hook_send_email_uri": "lorem",
115
"hook_send_email_secrets": "lorem",
116
"hook_before_user_created_enabled": true,
117
"hook_before_user_created_uri": "lorem",
118
"hook_before_user_created_secrets": "lorem",
119
"hook_after_user_created_enabled": true,
120
"hook_after_user_created_uri": "lorem",
121
"hook_after_user_created_secrets": "lorem",
122
"jwt_exp": 42,
123
"mailer_allow_unverified_email_sign_ins": true,
124
"mailer_autoconfirm": true,
125
"mailer_otp_exp": 42,
126
"mailer_otp_length": 42,
127
"mailer_secure_email_change_enabled": true,
128
"mailer_subjects_confirmation": "lorem",
129
"mailer_subjects_email_change": "lorem",
130
"mailer_subjects_invite": "lorem",
131
"mailer_subjects_magic_link": "lorem",
132
"mailer_subjects_reauthentication": "lorem",
133
"mailer_subjects_recovery": "lorem",
134
"mailer_subjects_password_changed_notification": "lorem",
135
"mailer_subjects_email_changed_notification": "lorem",
136
"mailer_subjects_phone_changed_notification": "lorem",
137
"mailer_subjects_mfa_factor_enrolled_notification": "lorem",
138
"mailer_subjects_mfa_factor_unenrolled_notification": "lorem",
139
"mailer_subjects_identity_linked_notification": "lorem",
140
"mailer_subjects_identity_unlinked_notification": "lorem",
141
"mailer_templates_confirmation_content": "lorem",
142
"mailer_templates_email_change_content": "lorem",
143
"mailer_templates_invite_content": "lorem",
144
"mailer_templates_magic_link_content": "lorem",
145
"mailer_templates_reauthentication_content": "lorem",
146
"mailer_templates_recovery_content": "lorem",
147
"mailer_templates_password_changed_notification_content": "lorem",
148
"mailer_templates_email_changed_notification_content": "lorem",
149
"mailer_templates_phone_changed_notification_content": "lorem",
150
"mailer_templates_mfa_factor_enrolled_notification_content": "lorem",
151
"mailer_templates_mfa_factor_unenrolled_notification_content": "lorem",
152
"mailer_templates_identity_linked_notification_content": "lorem",
153
"mailer_templates_identity_unlinked_notification_content": "lorem",
154
"mailer_notifications_password_changed_enabled": true,
155
"mailer_notifications_email_changed_enabled": true,
156
"mailer_notifications_phone_changed_enabled": true,
157
"mailer_notifications_mfa_factor_enrolled_enabled": true,
158
"mailer_notifications_mfa_factor_unenrolled_enabled": true,
159
"mailer_notifications_identity_linked_enabled": true,
160
"mailer_notifications_identity_unlinked_enabled": true,
161
"mfa_max_enrolled_factors": 42,
162
"mfa_totp_enroll_enabled": true,
163
"mfa_totp_verify_enabled": true,
164
"mfa_phone_enroll_enabled": true,
165
"mfa_phone_verify_enabled": true,
166
"mfa_web_authn_enroll_enabled": true,
167
"mfa_web_authn_verify_enabled": true,
168
"passkey_enabled": true,
169
"webauthn_rp_display_name": "lorem",
170
"webauthn_rp_id": "lorem",
171
"webauthn_rp_origins": "lorem",
172
"mfa_phone_otp_length": 42,
173
"mfa_phone_template": "lorem",
174
"mfa_phone_max_frequency": 42,
175
"nimbus_oauth_client_id": "lorem",
176
"nimbus_oauth_email_optional": true,
177
"nimbus_oauth_client_secret": "lorem",
178
"password_hibp_enabled": true,
179
"password_min_length": 42,
180
"password_required_characters": "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ:0123456789",
181
"rate_limit_anonymous_users": 42,
182
"rate_limit_email_sent": 42,
183
"rate_limit_sms_sent": 42,
184
"rate_limit_token_refresh": 42,
185
"rate_limit_verify": 42,
186
"rate_limit_otp": 42,
187
"rate_limit_web3": 42,
188
"refresh_token_rotation_enabled": true,
189
"saml_enabled": true,
190
"saml_external_url": "lorem",
191
"saml_allow_encrypted_assertions": true,
192
"security_sb_forwarded_for_enabled": true,
193
"security_captcha_enabled": true,
194
"security_captcha_provider": "turnstile",
195
"security_captcha_secret": "lorem",
196
"security_manual_linking_enabled": true,
197
"security_refresh_token_reuse_interval": 42,
198
"security_update_password_require_reauthentication": true,
199
"sessions_inactivity_timeout": 42,
200
"sessions_single_per_user": true,
201
"sessions_tags": "lorem",
202
"sessions_timebox": 42,
203
"site_url": "lorem",
204
"sms_autoconfirm": true,
205
"sms_max_frequency": 42,
206
"sms_messagebird_access_key": "lorem",
207
"sms_messagebird_originator": "lorem",
208
"sms_otp_exp": 42,
209
"sms_otp_length": 42,
210
"sms_provider": "messagebird",
211
"sms_template": "lorem",
212
"sms_test_otp": "lorem",
213
"sms_test_otp_valid_until": "2021-12-31T23:34:00Z",
214
"sms_textlocal_api_key": "lorem",
215
"sms_textlocal_sender": "lorem",
216
"sms_twilio_account_sid": "lorem",
217
"sms_twilio_auth_token": "lorem",
218
"sms_twilio_content_sid": "lorem",
219
"sms_twilio_message_service_sid": "lorem",
220
"sms_twilio_verify_account_sid": "lorem",
221
"sms_twilio_verify_auth_token": "lorem",
222
"sms_twilio_verify_message_service_sid": "lorem",
223
"sms_vonage_api_key": "lorem",
224
"sms_vonage_api_secret": "lorem",
225
"sms_vonage_from": "lorem",
226
"smtp_admin_email": "jon.snow@targaryen.com",
227
"smtp_host": "lorem",
228
"smtp_max_frequency": 42,
229
"smtp_pass": "lorem",
230
"smtp_port": "lorem",
231
"smtp_sender_name": "lorem",
232
"smtp_user": "lorem",
233
"uri_allow_list": "lorem",
234
"oauth_server_enabled": true,
235
"oauth_server_allow_dynamic_registration": true,
236
"oauth_server_authorization_path": "lorem",
237
"custom_oauth_enabled": true,
238
"custom_oauth_max_providers": 42
239
}