BasicAuthProvider

class BasicAuthProvider(credentials: suspend () -> BasicAuthCredentials?, realm: String? = null, sendWithoutRequestCallback: (HttpRequestBuilder) -> Boolean = { false }) : AuthProvider

An authentication provider for the Basic HTTP authentication scheme. The Basic authentication scheme can be used for logging in users.

You can learn more from Basic authentication.

Constructors

constructor(username: String, password: String, realm: String? = null, sendWithoutRequest: Boolean = false)

constructor(credentials: suspend () -> BasicAuthCredentials?, realm: String? = null, sendWithoutRequestCallback: (HttpRequestBuilder) -> Boolean = { false })

Waits for HttpStatusCode.Unauthorized to send credentials.

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

Adds an authentication method headers and credentials.

Clears the currently stored authentication tokens from the cache.

Checks if the current provider is applicable to a request.

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

Refreshes a token if required.