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

Auth

sealed interface Auth : MainPlugin<AuthConfig> , CustomSerializationPlugin(source)

Plugin to interact with the Supabase Auth API

To use it you need to install it to the SupabaseClient:

val supabase = createSupabaseClient(supabaseUrl, supabaseKey) {
   install(Auth)
}

then you can use it like this:

val result = supabase.auth.signUpWith(Email) {
  email = "example@email.com"
  password = "password"
}

Types

Companion

object Companion : SupabasePluginProvider<AuthConfig, Auth>

Properties

admin

abstract val admin: AdminApi

Access to the auth admin api where you can manage users. Service role access token is required. Import it via importAuthToken. Never share it publicly

apiVersion

abstract val apiVersion: Int

codeVerifierCache

abstract val codeVerifierCache: CodeVerifierCache

The cache for the code verifier. This is used for PKCE authentication. Can be customized via AuthConfig.codeVerifierCache

config

abstract val config: AuthConfig

isAutoRefreshRunning

abstract val isAutoRefreshRunning: Boolean

Whether the sessionStatus session is getting refreshed automatically

mfa

abstract val mfa: MfaApi

Access to the mfa api where you can manage multi-factor authentication for the current user.

pluginKey

abstract val pluginKey: String

serializer

abstract val serializer: SupabaseSerializer

sessionManager

abstract val sessionManager: SessionManager

Returns the session manager instance

sessionStatus

abstract val sessionStatus: StateFlow<SessionStatus>

Returns the current session status

supabaseClient

abstract val supabaseClient: SupabaseClient

Functions

awaitInitialization

abstract suspend fun awaitInitialization()

Blocks the current coroutine until the plugin is initialized.

clearSession

abstract suspend fun clearSession()

Deletes the current session from storage and sets sessionStatus to SessionStatus.NotAuthenticated

open suspend fun close()

createDefaultCodeVerifierCache

expect fun Auth.createDefaultCodeVerifierCache(): CodeVerifierCache

actual fun Auth.createDefaultCodeVerifierCache(): CodeVerifierCache

createDefaultSessionManager

expect fun Auth.createDefaultSessionManager(): SessionManager

actual fun Auth.createDefaultSessionManager(): SessionManager

currentAccessTokenOrNull

open fun currentAccessTokenOrNull(): String?

Returns the current access token, or null if no session is available

currentIdentitiesOrNull

open fun currentIdentitiesOrNull(): List<Identity>?

Returns the connected identities to the current user or null

currentSessionOrNull

open fun currentSessionOrNull(): UserSession?

Returns the current session or null

currentUserOrNull

open fun currentUserOrNull(): UserInfo?

Returns the current user or null

exchangeCodeForSession

abstract suspend fun exchangeCodeForSession(code: String, saveSession: Boolean = true): UserSession

Exchanges a code for a session. Used when using the FlowType.PKCE flow

getOAuthUrl

abstract fun getOAuthUrl(provider: OAuthProvider, redirectUrl: String? = defaultRedirectUrl(), url: String = "authorize", additionalConfig: ExternalAuthConfigDefaults.() -> Unit = {}): String

Returns the url to use for oAuth

importAuthToken

open suspend fun importAuthToken(accessToken: String, refreshToken: String = "", retrieveUser: Boolean = false, autoRefresh: Boolean = if(refreshToken.isNotBlank()) config.alwaysAutoRefresh else false)

Imports the jwt token and retrieves the user profile. Be aware auto-refreshing is not available when importing only a jwt token.

importSession

abstract suspend fun importSession(session: UserSession, autoRefresh: Boolean = config.alwaysAutoRefresh, source: SessionSource = SessionSource.Unknown)

Imports a user session and starts auto-refreshing if autoRefresh is true

init

open fun init()

linkIdentity

abstract suspend fun linkIdentity(provider: OAuthProvider, redirectUrl: String? = defaultRedirectUrl(), config: ExternalAuthConfigDefaults.() -> Unit = {}): String?

Links an OAuth Identity to an existing user.

loadFromStorage

abstract suspend fun loadFromStorage(autoRefresh: Boolean = config.alwaysAutoRefresh): Boolean

Retrieves the latest session from storage and starts auto-refreshing if autoRefresh is true or AuthConfig.alwaysAutoRefresh as the default parameter

parseErrorResponse

abstract suspend fun parseErrorResponse(response: HttpResponse): RestException

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.

reauthenticate

abstract suspend fun reauthenticate()

Sends a nonce to the user's email (preferred) or phone

refreshCurrentSession

abstract suspend fun refreshCurrentSession()

Refreshes the current session

refreshSession

abstract suspend fun refreshSession(refreshToken: String): UserSession

Refreshes a session using the refresh token

resendEmail

abstract suspend fun resendEmail(type: OtpType.Email, email: String, captchaToken: String? = null)

Resends an existing signup confirmation email, email change email

resendPhone

abstract suspend fun resendPhone(type: OtpType.Phone, phone: String, captchaToken: String? = null)

Resends an existing SMS OTP or phone change OTP.

resetPasswordForEmail

abstract suspend fun resetPasswordForEmail(email: String, redirectUrl: String? = defaultRedirectUrl(), captchaToken: String? = null)

Sends a password reset email to the user with the specified email

resolveUrl

open fun resolveUrl(path: String): String

retrieveSSOUrl

abstract suspend fun retrieveSSOUrl(redirectUrl: String? = defaultRedirectUrl(), config: SSO.Config.() -> Unit): SSO.Result

Retrieves the sso url for the given config

retrieveUser

abstract suspend fun retrieveUser(jwt: String): UserInfo

Retrieves the user attached to the specified jwt

retrieveUserForCurrentSession

abstract suspend fun retrieveUserForCurrentSession(updateSession: Boolean = false): UserInfo

Retrieves the current user with the current session

setupPlatform

expect fun Auth.setupPlatform()

actual fun Auth.setupPlatform()

signInAnonymously

abstract suspend fun signInAnonymously(data: JsonObject? = null, captchaToken: String? = null)

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

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.

signInWith

abstract suspend fun <C, R, Provider : AuthProvider<C, R>> signInWith(provider: Provider, redirectUrl: String? = defaultRedirectUrl(), config: C.() -> Unit? = null)

Signs in the user with the specified provider

signOut

abstract suspend fun signOut(scope: SignOutScope = SignOutScope.LOCAL)

Signs out the current user, which means sessionStatus will be SessionStatus.NotAuthenticated and the access token will be revoked

signUpWith

abstract suspend fun <C, R, Provider : AuthProvider<C, R>> signUpWith(provider: Provider, redirectUrl: String? = defaultRedirectUrl(), config: C.() -> Unit? = null): R?

Signs up a new user with the specified provider

startAutoRefreshForCurrentSession

abstract suspend fun startAutoRefreshForCurrentSession()

Starts auto refreshing the current session

stopAutoRefreshForCurrentSession

abstract fun stopAutoRefreshForCurrentSession()

Stops auto-refreshing the current session

unlinkIdentity

abstract suspend fun unlinkIdentity(identityId: String, updateLocalUser: Boolean = true)

Unlinks an OAuth Identity from an existing user.

updateUser

abstract suspend fun updateUser(updateCurrentUser: Boolean = true, redirectUrl: String? = defaultRedirectUrl(), config: UserUpdateBuilder.() -> Unit): UserInfo

Modifies the current user

verifyEmailOtp

abstract suspend fun verifyEmailOtp(type: OtpType.Email, tokenHash: String, captchaToken: String? = null)

Verifies a email otp token hash received via email

abstract suspend fun verifyEmailOtp(type: OtpType.Email, email: String, token: String, captchaToken: String? = null)

Verifies a email otp

verifyPhoneOtp

abstract suspend fun verifyPhoneOtp(type: OtpType.Phone, phone: String, token: String, captchaToken: String? = null)

Verifies a phone/sms otp