BearerAuthProvider
class BearerAuthProvider(refreshTokens: suspend RefreshTokensParams.() -> BearerTokens?, loadTokens: suspend () -> BearerTokens?, sendWithoutRequestCallback: (HttpRequestBuilder) -> Boolean = { true }, realm: String?, cacheTokens: Boolean = true, nonCancellableRefresh: Boolean = false) : AuthProvider(source)
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
Link copied to clipboard
constructor(refreshTokens: suspend RefreshTokensParams.() -> BearerTokens?, loadTokens: suspend () -> BearerTokens?, sendWithoutRequestCallback: (HttpRequestBuilder) -> Boolean = { true }, realm: String?, cacheTokens: Boolean = true, nonCancellableRefresh: Boolean = false)
Properties
Link copied to clipboard
Waits for HttpStatusCode.Unauthorized to send credentials.
Functions
Link copied to clipboard
open suspend override fun addRequestHeaders(request: HttpRequestBuilder, authHeader: HttpAuthHeader?)
Adds an authentication method headers and credentials.
Link copied to clipboard
Clears the currently stored authentication tokens from the cache.
Link copied to clipboard
Checks if current provider is applicable to the request.
Link copied to clipboard
Refreshes a token if required.
Link copied to clipboard