ktor-client-auth/io.ktor.client.plugins.auth.providers/BearerAuthConfig

BearerAuthConfig

class BearerAuthConfig(source)

A configuration for BearerAuthProvider.

Report a problem

Constructors

BearerAuthConfig

constructor()

Properties

cacheTokens

var cacheTokens: Boolean

Configures whether to cache the result of loadTokens.

nonCancellableRefresh

var nonCancellableRefresh: Boolean

When enabled, token refresh function is executed in a NonCancellable coroutine context. This prevents cancellation of the originating request from rolling back a successful token refresh.

realm

var realm: String?

Specifies the authentication realm this provider should answer.

Functions

loadTokens

fun loadTokens(block: suspend () -> BearerTokens?)

Configures a callback that loads a cached token from a local storage. Note: Using the same client instance here to make a request will result in a deadlock.

refreshTokens

fun refreshTokens(block: suspend RefreshTokensParams.() -> BearerTokens?)

Configures a callback that refreshes bearer tokens when the client receives an unauthorized response.

sendWithoutRequest

fun sendWithoutRequest(block: (HttpRequestBuilder) -> Boolean)

Configures when bearer credentials are sent without waiting for HttpStatusCode.Unauthorized.