SUsupabase
general

Retrieve some of the public settings of the server.

Changed on

Use this endpoint to configure parts of any authentication UIs depending on the configured settings.

get/settings

Request

  • Base URL
    https://abcdefghijklmnopqrst.supabase.co/auth/v1
  • URL
    https://abcdefghijklmnopqrst.supabase.co/auth/v1/settings
  • Auth
    API key in header apikey

Response

Currently applicable settings of the server.

disable_signupboolean

Whether new accounts can be created. (Valid for all providers.)

mailer_autoconfirmboolean

Whether new email addresses need to be confirmed before sign-in is possible.

phone_autoconfirmboolean

Whether new phone numbers need to be confirmed before sign-in is possible.

sms_providerstring

Which SMS provider is being used to send messages to phone numbers.

saml_enabledboolean

Whether SAML is enabled on this API server. Defaults to false.

externalobject

Which external identity providers are enabled.

Example response

{
  "sms_provider": "twilio",
  "saml_enabled": true,
  "external": {
    "github": true,
    "apple": true,
    "email": true,
    "phone": true
  }
}

Changes