Clerk Android API/com.clerk.api/ClerkConfigurationOptions

ClerkConfigurationOptions

data class ClerkConfigurationOptions(val enableDebugMode: Boolean = false, val proxyUrl: String? = null, val telemetryEnabled: Boolean = true, val sharedSessionSync: SharedSessionSyncConfig? = null)

Data class for enabling extra functionality on the Clerk SDK.

Constructors

constructor(enableDebugMode: Boolean = false, proxyUrl: String? = null, telemetryEnabled: Boolean = true, sharedSessionSync: SharedSessionSyncConfig? = null)

Properties

autoRefreshOnForeground

val autoRefreshOnForeground: Boolean

Whether the client and environment are refreshed from the server every time the app returns to the foreground. Defaults to true.

customHeaders

val customHeaders: Map<String, String>

Additional headers to append to outgoing Clerk API requests.

enableDebugMode

val enableDebugMode: Boolean

If true, enables verbose logging for SDK operations and API calls. Defaults to false.

proxyUrl

val proxyUrl: String?

Optional proxy URL for network requests Your Clerk app's proxy URL. Required for applications that run behind a reverse proxy. Must be a full URL (for example, https://proxy.example.com/__clerk).

sharedSessionSync

val sharedSessionSync: SharedSessionSyncConfig?

Optional configuration for synchronizing Clerk state between same-signed sibling apps that use the same publishable key.

telemetryEnabled

val telemetryEnabled: Boolean

Whether to enable telemetry for this SDK instance.

Functions

withCustomHeaders

fun withCustomHeaders(customHeaders: Map<String, String>): ClerkConfigurationOptions

Returns a copy of these options with additional outgoing request headers configured.

withForegroundRefreshDisabled

fun withForegroundRefreshDisabled(): ClerkConfigurationOptions

Returns a copy of these options that skips the client and environment refresh on app foreground. Intended for host SDKs (for example, the Expo SDK) that own client state and perform their own refreshes; the initial refresh during Clerk.initialize and periodic session token refresh are unaffected.