auth-kt/io.github.jan.supabase.auth/AuthConfig

AuthConfig

actual class AuthConfig : AuthConfigDefaults(source)

The configuration for Auth

expect class AuthConfig : AuthConfigDefaults(source)

The configuration for Auth

actual class AuthConfig : AuthConfigDefaults(source)

The configuration for Auth

actual class AuthConfig : AuthConfigDefaults(source)

The configuration for Auth

actual class AuthConfig : AuthConfigDefaults(source)

The configuration for Auth

actual class AuthConfig : AuthConfigDefaults(source)

The configuration for Auth

actual class AuthConfig : AuthConfigDefaults(source)

The configuration for Auth

Constructors

Link copied to clipboard
constructor()
expect constructor()
constructor()
constructor()
constructor()
constructor()
constructor()

Properties

alwaysAutoRefresh
Link copied to clipboard
var alwaysAutoRefresh: Boolean

Whether to always automatically refresh the session, when it expires

var alwaysAutoRefresh: Boolean

Whether to always automatically refresh the session, when it expires

var alwaysAutoRefresh: Boolean

Whether to always automatically refresh the session, when it expires

var alwaysAutoRefresh: Boolean

Whether to always automatically refresh the session, when it expires

var alwaysAutoRefresh: Boolean

Whether to always automatically refresh the session, when it expires

var alwaysAutoRefresh: Boolean

Whether to always automatically refresh the session, when it expires

var alwaysAutoRefresh: Boolean

Whether to always automatically refresh the session, when it expires

autoLoadFromStorage
Link copied to clipboard
var autoLoadFromStorage: Boolean

Whether to automatically load the session from sessionManager, when Auth is initialized

var autoLoadFromStorage: Boolean

Whether to automatically load the session from sessionManager, when Auth is initialized

var autoLoadFromStorage: Boolean

Whether to automatically load the session from sessionManager, when Auth is initialized

var autoLoadFromStorage: Boolean

Whether to automatically load the session from sessionManager, when Auth is initialized

var autoLoadFromStorage: Boolean

Whether to automatically load the session from sessionManager, when Auth is initialized

var autoLoadFromStorage: Boolean

Whether to automatically load the session from sessionManager, when Auth is initialized

var autoLoadFromStorage: Boolean

Whether to automatically load the session from sessionManager, when Auth is initialized

autoSaveToStorage
Link copied to clipboard
var autoSaveToStorage: Boolean

Whether to automatically save the session to sessionManager, when the session changes

var autoSaveToStorage: Boolean

Whether to automatically save the session to sessionManager, when the session changes

var autoSaveToStorage: Boolean

Whether to automatically save the session to sessionManager, when the session changes

var autoSaveToStorage: Boolean

Whether to automatically save the session to sessionManager, when the session changes

var autoSaveToStorage: Boolean

Whether to automatically save the session to sessionManager, when the session changes

var autoSaveToStorage: Boolean

Whether to automatically save the session to sessionManager, when the session changes

var autoSaveToStorage: Boolean

Whether to automatically save the session to sessionManager, when the session changes

autoSetupPlatform
Link copied to clipboard
var autoSetupPlatform: Boolean

Whether to automatically set up the current platform. For testing.

var autoSetupPlatform: Boolean

Whether to automatically set up the current platform. For testing.

var autoSetupPlatform: Boolean

Whether to automatically set up the current platform. For testing.

var autoSetupPlatform: Boolean

Whether to automatically set up the current platform. For testing.

var autoSetupPlatform: Boolean

Whether to automatically set up the current platform. For testing.

var autoSetupPlatform: Boolean

Whether to automatically set up the current platform. For testing.

var autoSetupPlatform: Boolean

Whether to automatically set up the current platform. For testing.

Link copied to clipboard
var browserBridge: BrowserBridge?

Interface to access browser properties like the current hash. By default, null on NodeJS. Can be changed for testing.

checkSessionOnRequest
Link copied to clipboard
var checkSessionOnRequest: Boolean

Whether to check if the current session is expired on an authenticated request and possibly try to refresh it.

var checkSessionOnRequest: Boolean

Whether to check if the current session is expired on an authenticated request and possibly try to refresh it.

var checkSessionOnRequest: Boolean

Whether to check if the current session is expired on an authenticated request and possibly try to refresh it.

var checkSessionOnRequest: Boolean

Whether to check if the current session is expired on an authenticated request and possibly try to refresh it.

var checkSessionOnRequest: Boolean

Whether to check if the current session is expired on an authenticated request and possibly try to refresh it.

var checkSessionOnRequest: Boolean

Whether to check if the current session is expired on an authenticated request and possibly try to refresh it.

var checkSessionOnRequest: Boolean

Whether to check if the current session is expired on an authenticated request and possibly try to refresh it.

codeVerifierCache
Link copied to clipboard
var codeVerifierCache: CodeVerifierCache?

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

var codeVerifierCache: CodeVerifierCache?

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

var codeVerifierCache: CodeVerifierCache?

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

var codeVerifierCache: CodeVerifierCache?

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

var codeVerifierCache: CodeVerifierCache?

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

var codeVerifierCache: CodeVerifierCache?

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

var codeVerifierCache: CodeVerifierCache?

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
Link copied to clipboard
var coroutineDispatcher: CoroutineDispatcher?

The dispatcher used for all auth related network requests

var coroutineDispatcher: CoroutineDispatcher?

The dispatcher used for all auth related network requests

var coroutineDispatcher: CoroutineDispatcher?

The dispatcher used for all auth related network requests

var coroutineDispatcher: CoroutineDispatcher?

The dispatcher used for all auth related network requests

var coroutineDispatcher: CoroutineDispatcher?

The dispatcher used for all auth related network requests

var coroutineDispatcher: CoroutineDispatcher?

The dispatcher used for all auth related network requests

var coroutineDispatcher: CoroutineDispatcher?

The dispatcher used for all auth related network requests

customUrl
Link copied to clipboard
var customUrl: String?
var customUrl: String?
var customUrl: String?
var customUrl: String?
var customUrl: String?
var customUrl: String?
var customUrl: String?
Link copied to clipboard
val AuthConfig.deepLink: String

The deeplink used for the implicit and PKCE flow. Throws an IllegalArgumentException, if either the scheme or host is not set

Link copied to clipboard
val AuthConfig.deepLinkOrNull: String?

The deeplink used for the implicit and PKCE flow. Returns null, if either the scheme or host is not set

Link copied to clipboard
var defaultExternalAuthAction: ExternalAuthAction

The action to use for the OAuth flow. Can be overriden per-request in the ExternalAuthConfig

defaultRedirectUrl
Link copied to clipboard
var defaultRedirectUrl: String?

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

var defaultRedirectUrl: String?

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

var defaultRedirectUrl: String?

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

var defaultRedirectUrl: String?

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

var defaultRedirectUrl: String?

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

var defaultRedirectUrl: String?

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

var defaultRedirectUrl: String?

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

Link copied to clipboard
var disableUrlChecking: Boolean

Whether to disable automatic URL checking for PKCE codes, error codes, and session tokens.

enableLifecycleCallbacks
Link copied to clipboard
var enableLifecycleCallbacks: Boolean

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

var enableLifecycleCallbacks: Boolean

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

var enableLifecycleCallbacks: Boolean

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

var enableLifecycleCallbacks: Boolean

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

var enableLifecycleCallbacks: Boolean

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

var enableLifecycleCallbacks: Boolean

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

var enableLifecycleCallbacks: Boolean

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

flowType
Link copied to clipboard
var flowType: FlowType

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

var flowType: FlowType

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

var flowType: FlowType

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

var flowType: FlowType

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

var flowType: FlowType

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

var flowType: FlowType

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

var flowType: FlowType

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

host
Link copied to clipboard
var host: String?

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

var host: String?

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

var host: String?

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

var host: String?

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

var host: String?

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

var host: String?

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

var host: String?

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

jwkCache
Link copied to clipboard
var jwkCache: JwkCache

A JwkCache is used to

var jwkCache: JwkCache

A JwkCache is used to

var jwkCache: JwkCache

A JwkCache is used to

var jwkCache: JwkCache

A JwkCache is used to

var jwkCache: JwkCache

A JwkCache is used to

var jwkCache: JwkCache

A JwkCache is used to

var jwkCache: JwkCache

A JwkCache is used to

jwtToken
Link copied to clipboard
var jwtToken: String?
var jwtToken: String?
var jwtToken: String?
var jwtToken: String?
var jwtToken: String?
var jwtToken: String?
var jwtToken: String?
requireValidSession
Link copied to clipboard
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.

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.

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.

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.

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.

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.

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
Link copied to clipboard
var retryDelay: Duration

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

var retryDelay: Duration

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

var retryDelay: Duration

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

var retryDelay: Duration

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

var retryDelay: Duration

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

var retryDelay: Duration

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

var retryDelay: Duration

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

scheme
Link copied to clipboard
var scheme: String?

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

var scheme: String?

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

var scheme: String?

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

var scheme: String?

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

var scheme: String?

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

var scheme: String?

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

var scheme: String?

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

serializer
Link copied to clipboard
open override var serializer: SupabaseSerializer?

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

open override var serializer: SupabaseSerializer?

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

open override var serializer: SupabaseSerializer?

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

open override var serializer: SupabaseSerializer?

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

open override var serializer: SupabaseSerializer?

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

open override var serializer: SupabaseSerializer?

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

open override var serializer: SupabaseSerializer?

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

sessionManager
Link copied to clipboard
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

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

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

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

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

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

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
Link copied to clipboard
var urlLauncher: UrlLauncher

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

var urlLauncher: UrlLauncher

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

var urlLauncher: UrlLauncher

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

var urlLauncher: UrlLauncher

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

var urlLauncher: UrlLauncher

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

var urlLauncher: UrlLauncher

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

var urlLauncher: UrlLauncher

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

Functions

Link copied to clipboard
fun httpCallbackConfig(block: HttpCallbackConfig.() -> Unit)

Configures the http callback for the web server, when logging in with OAuth or SSO.

Link copied to clipboard
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.

Link copied to clipboard
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.

Generated by Dokka
© 2026 Copyright