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

AuthProvider

interface AuthProvider

Authentication provider interface.

Properties

sendWithoutRequest

abstract val sendWithoutRequest: Boolean

Wait for HttpStatusCode.Unauthorized to send credentials.

Functions

addRequestHeaders

abstract suspend fun addRequestHeaders(request: HttpRequestBuilder): Unit

Add authentication method headers and creds.

isApplicable

abstract fun isApplicable(auth: HttpAuthHeader): Boolean

Check if current provider is applicable to the request.

refreshToken

open suspend fun refreshToken(response: HttpResponse): Boolean

Refresh token if required.

sendWithoutRequest

open fun sendWithoutRequest(request: HttpRequestBuilder): Boolean

Inheritors

BasicAuthProvider

class BasicAuthProvider : AuthProvider

Client basic authentication provider.

BearerAuthProvider

class BearerAuthProvider : AuthProvider

Client bearer AuthProvider.

DigestAuthProvider

class DigestAuthProvider : AuthProvider

Client digest AuthProvider.