The cache used to store/load the code verifier for the FlowType.PKCE flow. When null, the default io.github.jan.supabase.auth.SettingsCodeVerifierCache will be used

coroutineDispatcher

var ~~coroutineDispatcher~~: CoroutineDispatcher?

The dispatcher used for all auth related network requests

customUrl

var customUrl: String?

defaultRedirectUrl

var defaultRedirectUrl: String?

The default redirect url used for authentication. When null, a platform specific default redirect url will be used.

enableLifecycleCallbacks

var enableLifecycleCallbacks: Boolean

Whether to stop auto-refresh on focus loss, and resume it on focus again.

flowType

var flowType: FlowType

The type of login flow to use. Defaults to FlowType.IMPLICIT

host

var host: String?

The deeplink host used for the implicit and PKCE flow. When null, deeplinks won't be used as redirect urls

jwtToken

var jwtToken: String?

requireValidSession

open override var requireValidSession: Boolean

Whether to require a valid UserSession in the Auth plugin to make any request with this plugin. The SupabaseClient.supabaseKey cannot be used as fallback.

retryDelay

var retryDelay: Duration

The duration after which Auth should retry refreshing a session, when it failed due to network issues

scheme

var scheme: String?

The deeplink scheme used for the implicit and PKCE flow. When null, deeplinks won't be used as redirect urls

serializer

open override var serializer: SupabaseSerializer?

A serializer used for serializing/deserializing objects e.g. in Auth.signInWith. Defaults to SupabaseClientBuilder.defaultSerializer, when null.

sessionManager

var sessionManager: SessionManager?

The session manager used to store/load the session. When null, the default io.github.jan.supabase.auth.SettingsSessionManager will be used

urlLauncher

var urlLauncher: UrlLauncher

The URL launcher used to open OAuth links in the system browser.

Functions

minimalConfig

fun AuthConfigDefaults.minimalConfig()

Applies minimal configuration to the AuthConfig. This is useful for server side applications, where you don't need to store the session or code verifier.

minimalSettings

fun AuthConfigDefaults.~~minimalSettings~~(alwaysAutoRefresh: Boolean = false, autoLoadFromStorage: Boolean = false, autoSaveToStorage: Boolean = false, sessionManager: SessionManager? = MemorySessionManager(), codeVerifierCache: CodeVerifierCache? = MemoryCodeVerifierCache(), enableLifecycleCallbacks: Boolean = false)

Applies minimal settings to the AuthConfig. This is useful for server side applications, where you don't need to store the session or code verifier.