class AuthenticatedSupabaseApi constructor(resolveUrl: (path: String) -> String, parseErrorResponse: suspend (response: HttpResponse) -> RestException? = null, defaultRequest: HttpRequestBuilder.() -> Unit? = null, supabaseClient: SupabaseClient, jwtToken: String? = null) : SupabaseApi

CodeVerifierCache

interface CodeVerifierCache

A cache for the code verifier used in the PKCE flow.

ExternalAuthAction

sealed interface ExternalAuthAction

Represents the available actions for external auth such as OAuth and SSO.

FlowType

enum FlowType : Enum<FlowType>

The type of login flow to use

HttpCallbackConfig

data class HttpCallbackConfig(var httpPort: Int = 0, var timeout: Duration = 1.minutes, var htmlTitle: String = "Supabase Auth", var redirectHtml: String = HttpCallbackHtml.redirectPage("https://supabase.com/brand-assets/supabase-logo-icon.png", "Supabase Auth", "Logged in. You may continue in your app"))

Http callback configuration for the web server, when logging in with OAuth.

MemoryCodeVerifierCache

class MemoryCodeVerifierCache(codeVerifier: String? = null) : CodeVerifierCache

A CodeVerifierCache that uses the AtomicRef API.

MemorySessionManager

class MemorySessionManager(session: UserSession? = null) : SessionManager

A SessionManager that uses the AtomicRef API.

OtpType

sealed interface OtpType

OTPs (One Time Passwords) are used to authenticate users via email or phone.

PostgrestFilterDSL

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.TYPE])

@DslMarker

annotation class PostgrestFilterDSL

Used to mark Postgrest filter DSL functions

SessionManager

interface SessionManager

Represents the session manager. Used for saving and restoring the session from storage

SettingsCodeVerifierCache

class SettingsCodeVerifierCache(settings: Settings = createDefaultSettings(), key: String = SETTINGS_KEY) : CodeVerifierCache

A CodeVerifierCache that uses the Settings API.

SettingsSessionManager

class SettingsSessionManager(settings: Settings = createDefaultSettings(), key: String = SETTINGS_KEY, json: Json = settingsJson) : SessionManager

A SessionManager that uses the Settings API.

SignOutScope

enum SignOutScope : Enum<SignOutScope>

Represents the scope of a sign-out action.

Properties

auth

val SupabaseClient.auth: Auth

The Auth plugin handles everything related to Supabase's authentication system

deepLink

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

deepLinkOrNull

val AuthConfig.deepLinkOrNull: String?

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

Functions

authenticatedSupabaseApi

fun SupabaseClient.authenticatedSupabaseApi(plugin: MainPlugin<*>, defaultRequest: HttpRequestBuilder.() -> Unit? = null): AuthenticatedSupabaseApi

Creates a AuthenticatedSupabaseApi for the given plugin. Requires Auth to authenticate requests All requests will be resolved using the MainPlugin.resolveUrl function

fun SupabaseClient.authenticatedSupabaseApi(baseUrl: String, parseErrorResponse: suspend (response: HttpResponse) -> RestException? = null): AuthenticatedSupabaseApi

Creates a AuthenticatedSupabaseApi with the given baseUrl. Requires Auth to authenticate requests All requests will be resolved relative to this url

fun SupabaseClient.authenticatedSupabaseApi(resolveUrl: (path: String) -> String, parseErrorResponse: suspend (response: HttpResponse) -> RestException? = null, defaultRequest: HttpRequestBuilder.() -> Unit? = null, jwtToken: String? = null): AuthenticatedSupabaseApi

Creates a AuthenticatedSupabaseApi with the given resolveUrl function. Requires Auth to authenticate requests All requests will be resolved using this function

createDefaultCodeVerifierCache

expect fun Auth.createDefaultCodeVerifierCache(): CodeVerifierCache

actual fun Auth.createDefaultCodeVerifierCache(): CodeVerifierCache

createDefaultSessionManager

expect fun Auth.createDefaultSessionManager(): SessionManager

actual fun Auth.createDefaultSessionManager(): SessionManager

createDefaultSettings

fun createDefaultSettings(): Settings

createDefaultSettingsKey

fun createDefaultSettingsKey(supabaseUrl: String): String

handleDeeplinks

fun SupabaseClient.handleDeeplinks(intent: Intent, onSessionSuccess: (UserSession) -> Unit = {})

Handle deeplinks for authentication. This handles the deeplinks for implicit and PKCE flow.

fun SupabaseClient.handleDeeplinks(url: NSURL, onSessionSuccess: (UserSession) -> Unit = {})

Handle deeplinks for authentication. This handles the deeplinks for the implicit and the PKCE flow.

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.

parseFragmentAndImportSession

fun Auth.parseFragmentAndImportSession(fragment: String, onSessionSuccess: (UserSession) -> Unit = {})

parseSessionFromFragment

fun Auth.parseSessionFromFragment(fragment: String): UserSession

Parses a session from a fragment.

parseSessionFromUrl

fun Auth.parseSessionFromUrl(url: String): UserSession

Parses a session from an url.

redirectTo

fun HttpRequestBuilder.redirectTo(url: String)

resolveAccessToken

suspend fun <C : MainConfig> SupabaseClient.resolveAccessToken(plugin: MainPlugin<C>, keyAsFallback: Boolean = true): String?

suspend fun SupabaseClient.resolveAccessToken(jwtToken: String? = null, keyAsFallback: Boolean = true): String?

Returns the access token used for requests. The token is resolved in the following order:

setupPlatform

expect fun Auth.setupPlatform()

actual fun Auth.setupPlatform()

signInAnonymously

inline suspend fun <T : Any> Auth.signInAnonymously(data: T, captchaToken: String? = null)

Signs in the user without any credentials. This will create a new user session with a new access token.