---
title: "Gets project's auth config"
method: GET
path: "/v1/projects/{ref}/config/auth"
tags: ["Auth"]
---

# Gets project's auth config

`GET /v1/projects/{ref}/config/auth`

## Path parameters

- `ref` string, required

## Response `200`

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

## Other responses

- `401` — Unauthorized
- `403` — Forbidden action
- `429` — Rate limit exceeded
- `500` — Failed to retrieve project's auth config

---

[API](https://skmtc.dev/supabase/apis/management-api.md) · [All operations](https://skmtc.dev/supabase/apis/management-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/supabase/management-api/revisions/a7cb39418064/schema)