ktor-client-auth / io.ktor.client.features.auth.providers / BearerAuthProvider

BearerAuthProvider

class BearerAuthProvider : AuthProvider

Client bearer AuthProvider.

Constructors

<init>

BearerAuthProvider(refreshTokens: suspend (response: HttpResponse) -> BearerTokens?, loadTokens: suspend () -> BearerTokens?, sendWithoutRequestCallback: (HttpRequestBuilder) -> Boolean = { true }, realm: String?)

Client bearer AuthProvider.

Properties

sendWithoutRequest

val sendWithoutRequest: Boolean

Wait for HttpStatusCode.Unauthorized to send credentials.

Functions

addRequestHeaders

suspend fun addRequestHeaders(request: HttpRequestBuilder): Unit

Add authentication method headers and creds.

clearToken

suspend fun clearToken(): Unit

isApplicable

fun isApplicable(auth: HttpAuthHeader): Boolean

Check if current provider is applicable to the request.

refreshToken

suspend fun refreshToken(response: HttpResponse): Boolean

Refresh token if required.

sendWithoutRequest

fun sendWithoutRequest(request: HttpRequestBuilder): Boolean