Supabase.GoTrue.Schemas.ServerSettings (supabase_gotrue v0.5.2)

View Source

Represents the configuration settings of the GoTrue authentication server.

This struct is returned by Supabase.GoTrue.get_server_settings/1 and contains information about the server's configuration, including available authentication methods and provider settings.

Fields

  • disable_signup - Whether new user signups are allowed
  • mailer_autoconfirm - Whether email signups are automatically confirmed
  • phone_autoconfirm - Whether phone signups are automatically confirmed
  • sms_provider - The provider used for SMS messaging
  • saml_enabled - Whether SAML authentication is enabled
  • external - Settings for external authentication providers
    • See external_t() type for all provider fields

External Providers

The external field contains boolean flags indicating which authentication providers are enabled, such as:

  • anonymous_users - Anonymous authentication
  • email - Email/password authentication
  • phone - Phone authentication
  • Third-party providers (google, github, etc.)

Summary

Types

external_t()

@type external_t() :: %Supabase.GoTrue.Schemas.ServerSettings.External{
  anonymous_users: boolean(),
  apple: boolean(),
  azure: boolean(),
  bitbucket: boolean(),
  discord: boolean(),
  email: boolean(),
  facebook: boolean(),
  figma: boolean(),
  fly: boolean(),
  github: boolean(),
  gitlab: boolean(),
  google: boolean(),
  kakao: boolean(),
  keycloak: boolean(),
  linkedin: boolean(),
  linkedin_oicd: boolean(),
  notion: boolean(),
  phone: boolean(),
  slack: boolean(),
  slack_oicd: boolean(),
  spotify: boolean(),
  twitch: boolean(),
  twitter: boolean(),
  workos: boolean(),
  zoom: boolean()
}

t()

@type t() :: %Supabase.GoTrue.Schemas.ServerSettings{
  disable_signup: boolean(),
  external: external_t(),
  mailer_autoconfirm: boolean(),
  phone_autoconfirm: boolean(),
  saml_enabled: boolean(),
  sms_provider: String.t()
}

Functions

parse(source \\ %__MODULE__{}, attrs)