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

BearerAuthProvider

class BearerAuthProvider(refreshTokens: suspend RefreshTokensParams.() -> BearerTokens?, loadTokens: suspend () -> BearerTokens?, sendWithoutRequestCallback: (HttpRequestBuilder) -> Boolean = { true }, realm: String?) : AuthProvider

An authentication provider for the Bearer HTTP authentication scheme. Bearer authentication involves security tokens called bearer tokens. As an example, these tokens can be used as a part of OAuth flow to authorize users of your application by using external providers, such as Google, Facebook, Twitter, and so on.

You can learn more from Bearer authentication.

Constructors

BearerAuthProvider

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

Functions

addRequestHeaders

open suspend override fun addRequestHeaders(request: HttpRequestBuilder, authHeader: HttpAuthHeader?)

Adds an authentication method headers and credentials.

fun clearToken()

open override fun isApplicable(auth: HttpAuthHeader): Boolean

Checks if current provider is applicable to the request.

open suspend override fun refreshToken(response: HttpResponse): Boolean

Refreshes a token if required.

sendWithoutRequest

open override fun sendWithoutRequest(request: HttpRequestBuilder): Boolean

Properties

sendWithoutRequest

open override val ~~sendWithoutRequest~~: Boolean

Waits for HttpStatusCode.Unauthorized to send credentials.