ktor-client-auth/io.ktor.client.plugins.auth/AuthProvider

AuthProvider

interface AuthProvider

An authentication provider.

Inheritors

BasicAuthProvider

BearerAuthProvider

DigestAuthProvider

Properties

sendWithoutRequest

abstract val ~~sendWithoutRequest~~: Boolean

Waits for HttpStatusCode.Unauthorized to send credentials.

Functions

addRequestHeaders

abstract suspend fun addRequestHeaders(request: HttpRequestBuilder, authHeader: HttpAuthHeader? = null)

Adds an authentication method headers and credentials.

abstract fun isApplicable(auth: HttpAuthHeader): Boolean

Checks if the current provider is applicable to a request.

open suspend fun refreshToken(response: HttpResponse): Boolean

Refreshes a token if required.

sendWithoutRequest

open fun sendWithoutRequest(request: HttpRequestBuilder): Boolean