ClerkConvexAuthProvider

class ClerkConvexAuthProvider : AuthProvider<String>

An AuthProvider that bridges Clerk authentication with Convex.

Uses Clerk's session management and JWT token generation to authenticate with a Convex backend. Automatically listens for session state changes and syncs Convex authentication accordingly.

Users must first sign in using Clerk. This provider then syncs Convex authentication automatically — no manual client.login() call is required.

See also

ConvexClientWithAuth

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
fun close()

Cancels session sync and releases resources.

Link copied to clipboard
fun ClerkConvexAuthProvider.createConvexClientWithAuth(deploymentUrl: String, context: Context): ConvexClientWithAuth<String>

Creates a dev.convex.android.ConvexClientWithAuth using this provider and starts Clerk session synchronization.

Link copied to clipboard
open override fun extractIdToken(authResult: String): String
Link copied to clipboard
open suspend override fun login(context: Context, onIdToken: (String?) -> Unit): Result<String>
Link copied to clipboard
open suspend override fun loginFromCache(onIdToken: (String?) -> Unit): Result<String>
Link copied to clipboard
open suspend override fun logout(context: Context): Result<Void?>