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

BasicAuthProvider

class BasicAuthProvider(credentials: suspend () -> BasicAuthCredentials?, realm: String?, sendWithoutRequestCallback: (HttpRequestBuilder) -> Boolean) : AuthProvider
Content copied to clipboard

Client basic authentication provider.

Constructors

Link copied to clipboard
fun BasicAuthProvider(username: String, password: String, realm: String? = null, sendWithoutRequest: Boolean = false)
Content copied to clipboard
Link copied to clipboard
fun BasicAuthProvider(credentials: suspend () -> BasicAuthCredentials?, realm: String? = null, sendWithoutRequestCallback: (HttpRequestBuilder) -> Boolean = { false })
Content copied to clipboard

Functions

Link copied to clipboard
open suspend override fun addRequestHeaders(request: HttpRequestBuilder)
Content copied to clipboard

Add authentication method headers and creds.

Link copied to clipboard
open override fun isApplicable(auth: HttpAuthHeader): Boolean
Content copied to clipboard

Check if current provider is applicable to the request.

Link copied to clipboard
open suspend override fun refreshToken(response: HttpResponse): Boolean
Content copied to clipboard

Refresh token if required.

Link copied to clipboard
open override fun sendWithoutRequest(request: HttpRequestBuilder): Boolean
Content copied to clipboard

Properties

Link copied to clipboard
open override val sendWithoutRequest: Boolean
Content copied to clipboard

Wait for HttpStatusCode.Unauthorized to send credentials.