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

Servers

Path parameters

Name Type Required Description
ref String Yes

Project ref

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
external_bitbucket_enabled Boolean No
external_figma_secret String No
mailer_templates_invite_content String No
external_gitlab_enabled Boolean No
smtp_user String No
mailer_allow_unverified_email_sign_ins Boolean No
sessions_tags String No
password_min_length Number No
external_discord_secret String No
mailer_templates_recovery_content String No
rate_limit_token_refresh Number No
sms_twilio_verify_account_sid String No
external_slack_secret String No
hook_send_email_enabled Boolean No
security_captcha_enabled Boolean No
hook_mfa_verification_attempt_enabled Boolean No
external_keycloak_secret String No
mailer_templates_email_change_content String No
external_spotify_secret String No
smtp_host String No
hook_password_verification_attempt_uri String No
external_kakao_enabled Boolean No
hook_send_sms_enabled Boolean No
external_kakao_secret String No
rate_limit_sms_sent Number No
external_email_enabled Boolean No
external_gitlab_secret String No
smtp_max_frequency Number No
hook_custom_access_token_uri String No
external_bitbucket_secret String No
external_zoom_enabled Boolean No
sms_provider String No
external_workos_enabled Boolean No
external_keycloak_enabled Boolean No
external_twitch_enabled Boolean No
external_apple_additional_client_ids String No
smtp_port String No
external_github_enabled Boolean No
hook_send_email_uri String No
external_linkedin_oidc_client_id String No
sms_twilio_account_sid String No
external_twitter_secret String No
external_gitlab_client_id String No
external_notion_enabled Boolean No
security_refresh_token_reuse_interval Number No
external_google_enabled Boolean No
mailer_subjects_reauthentication String No
external_gitlab_url String No
sms_vonage_from String No
external_bitbucket_client_id String No
sms_otp_length Number No
hook_send_sms_uri String No
mailer_secure_email_change_enabled Boolean No
hook_custom_access_token_enabled Boolean No
mailer_templates_confirmation_content String No
mailer_otp_exp Number No
external_azure_url String No
external_discord_client_id String No
refresh_token_rotation_enabled Boolean No
external_kakao_client_id String No
external_figma_client_id String No
security_update_password_require_reauthentication Boolean No
external_apple_enabled Boolean No
sessions_single_per_user Boolean No
sms_textlocal_sender String No
security_captcha_secret String No
external_phone_enabled Boolean No
external_zoom_secret String No
sms_vonage_api_secret String No
external_github_secret String No
external_google_client_id String No
uri_allow_list String No
password_hibp_enabled Boolean No
disable_signup Boolean No
mailer_templates_magic_link_content String No
external_linkedin_oidc_secret String No
external_twitch_client_id String No
security_captcha_provider String No
sms_textlocal_api_key String No
sms_autoconfirm Boolean No
mailer_subjects_invite String No
sessions_timebox Number No
external_azure_client_id String No
external_figma_enabled Boolean No
external_workos_url String No
rate_limit_anonymous_users Number No
external_workos_client_id String No
sms_test_otp String No
external_apple_secret String No
external_google_skip_nonce_check Boolean No
external_slack_enabled Boolean No
external_spotify_client_id String No
external_github_client_id String No
external_anonymous_users_enabled Boolean No
external_workos_secret String No
external_spotify_enabled Boolean No
site_url String No
smtp_pass String No
sms_messagebird_originator String No
mfa_max_enrolled_factors Number No
external_facebook_secret String No
external_discord_enabled Boolean No
sms_twilio_verify_message_service_sid String No
rate_limit_email_sent Number No
mailer_autoconfirm Boolean No
external_keycloak_client_id String No
sms_twilio_verify_auth_token String No
sms_twilio_message_service_sid String No
password_required_characters String No

Possible values:

  • ""
  • "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ:0123456789"
  • "abcdefghijklmnopqrstuvwxyz:ABCDEFGHIJKLMNOPQRSTUVWXYZ:0123456789:!@#$%^&*()_+-=[]{};'\\\\:\"|<>?,./`~"
  • "abcdefghijklmnopqrstuvwxyz:ABCDEFGHIJKLMNOPQRSTUVWXYZ:0123456789"
external_keycloak_url String No
mailer_templates_reauthentication_content String No
external_google_secret String No
hook_mfa_verification_attempt_uri String No
external_azure_enabled Boolean No
mailer_subjects_confirmation String No
sms_test_otp_valid_until String No
external_facebook_client_id String No
rate_limit_verify Number No
security_manual_linking_enabled Boolean No
external_slack_client_id String No
mailer_subjects_email_change String No
saml_enabled Boolean No
external_notion_secret String No
hook_password_verification_attempt_enabled Boolean No
external_twitter_client_id String No
sms_template String No
mailer_subjects_recovery String No
sms_vonage_api_key String No
external_notion_client_id String No
external_twitch_secret String No
sms_twilio_auth_token String No
external_google_additional_client_ids String No
external_twitter_enabled Boolean No
sessions_inactivity_timeout Number No
smtp_admin_email String No
sms_twilio_content_sid String No
jwt_exp Number No
smtp_sender_name String No
mailer_subjects_magic_link String No
sms_otp_exp Number No
external_linkedin_oidc_enabled Boolean No
external_facebook_enabled Boolean No
sms_max_frequency Number No
external_zoom_client_id String No
sms_messagebird_access_key String No
external_apple_client_id String No
external_azure_secret String No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.