ktor-client-auth

alltypes

class Auth

Auth(providers: MutableList<AuthProvider> = mutableListOf())
companion object Feature : HttpClientFeature<Auth, Auth>

fun install(feature: Auth, scope: HttpClient): Unit
val key: AttributeKey<Auth>
fun prepare(block: Auth.() -> Unit): Auth

fun install(feature: Auth, scope: HttpClient): Unit
val key: AttributeKey<Auth>
fun prepare(block: Auth.() -> Unit): Auth
val providers: MutableList<AuthProvider>

interface AuthProvider

abstract suspend fun addRequestHeaders(request: HttpRequestBuilder): Unit
abstract fun isApplicable(auth: HttpAuthHeader): Boolean
open suspend fun refreshToken(response: HttpResponse): Boolean
abstract val sendWithoutRequest: Boolean
open fun sendWithoutRequest(request: HttpRequestBuilder): Boolean

class BasicAuthConfig

BasicAuthConfig()
fun credentials(block: suspend () -> BasicAuthCredentials?): Unit
lateinit var password: String
var realm: String?
var sendWithoutRequest: Boolean
fun sendWithoutRequest(block: (HttpRequestBuilder) -> Boolean): Unit
lateinit var username: String

class BasicAuthCredentials

BasicAuthCredentials(username: String, password: String)
val password: String
val username: String

class BasicAuthProvider : AuthProvider

BasicAuthProvider(username: String, password: String, realm: String? = null, sendWithoutRequest: Boolean = false)
BasicAuthProvider(credentials: suspend () -> BasicAuthCredentials?, realm: String? = null, sendWithoutRequestCallback: (HttpRequestBuilder) -> Boolean = { false })
suspend fun addRequestHeaders(request: HttpRequestBuilder): Unit
fun isApplicable(auth: HttpAuthHeader): Boolean
suspend fun refreshToken(response: HttpResponse): Boolean
val sendWithoutRequest: Boolean
fun sendWithoutRequest(request: HttpRequestBuilder): Boolean

class BearerAuthConfig

BearerAuthConfig()
fun loadTokens(block: suspend () -> BearerTokens?): Unit
var realm: String?
fun refreshTokens(block: suspend (response: HttpResponse) -> BearerTokens?): Unit
fun sendWithoutRequest(block: (HttpRequestBuilder) -> Boolean): Unit

class BearerAuthProvider : AuthProvider

BearerAuthProvider(refreshTokens: suspend (response: HttpResponse) -> BearerTokens?, loadTokens: suspend () -> BearerTokens?, sendWithoutRequestCallback: (HttpRequestBuilder) -> Boolean = { true }, realm: String?)
suspend fun addRequestHeaders(request: HttpRequestBuilder): Unit
suspend fun clearToken(): Unit
fun isApplicable(auth: HttpAuthHeader): Boolean
suspend fun refreshToken(response: HttpResponse): Boolean
val sendWithoutRequest: Boolean
fun sendWithoutRequest(request: HttpRequestBuilder): Boolean

class BearerTokens

BearerTokens(accessToken: String, refreshToken: String)
val accessToken: String
val refreshToken: String

class DigestAuthConfig

DigestAuthConfig()
var algorithmName: String
fun credentials(block: suspend () -> DigestAuthCredentials?): Unit
var password: String
var realm: String?
var username: String

class DigestAuthCredentials

DigestAuthCredentials(username: String, password: String)
val password: String
val username: String

class DigestAuthProvider : AuthProvider

DigestAuthProvider(username: String, password: String, realm: String? = null, algorithmName: String = "MD5")
DigestAuthProvider(credentials: suspend () -> DigestAuthCredentials?, realm: String? = null, algorithmName: String = "MD5")
suspend fun addRequestHeaders(request: HttpRequestBuilder): Unit
val algorithmName: String
fun isApplicable(auth: HttpAuthHeader): Boolean
val password: String
val realm: String?
suspend fun refreshToken(response: HttpResponse): Boolean
val sendWithoutRequest: Boolean
fun sendWithoutRequest(request: HttpRequestBuilder): Boolean
val username: String

io.ktor.client.HttpClientConfig

fun HttpClientConfig<*>.Auth(block: Auth.() -> Unit): Unit

package io.ktor.client.features.auth

class Auth

Auth(providers: MutableList<AuthProvider> = mutableListOf())
companion object Feature : HttpClientFeature<Auth, Auth>

fun install(feature: Auth, scope: HttpClient): Unit
val key: AttributeKey<Auth>
fun prepare(block: Auth.() -> Unit): Auth

fun install(feature: Auth, scope: HttpClient): Unit
val key: AttributeKey<Auth>
fun prepare(block: Auth.() -> Unit): Auth
val providers: MutableList<AuthProvider>

interface AuthProvider

abstract suspend fun addRequestHeaders(request: HttpRequestBuilder): Unit
abstract fun isApplicable(auth: HttpAuthHeader): Boolean
open suspend fun refreshToken(response: HttpResponse): Boolean
abstract val sendWithoutRequest: Boolean
open fun sendWithoutRequest(request: HttpRequestBuilder): Boolean

io.ktor.client.HttpClientConfig

fun HttpClientConfig<*>.Auth(block: Auth.() -> Unit): Unit

package io.ktor.client.features.auth.providers

class BasicAuthConfig

BasicAuthConfig()
fun credentials(block: suspend () -> BasicAuthCredentials?): Unit
lateinit var password: String
var realm: String?
var sendWithoutRequest: Boolean
fun sendWithoutRequest(block: (HttpRequestBuilder) -> Boolean): Unit
lateinit var username: String

class BasicAuthCredentials

BasicAuthCredentials(username: String, password: String)
val password: String
val username: String

class BasicAuthProvider : AuthProvider

BasicAuthProvider(username: String, password: String, realm: String? = null, sendWithoutRequest: Boolean = false)
BasicAuthProvider(credentials: suspend () -> BasicAuthCredentials?, realm: String? = null, sendWithoutRequestCallback: (HttpRequestBuilder) -> Boolean = { false })
suspend fun addRequestHeaders(request: HttpRequestBuilder): Unit
fun isApplicable(auth: HttpAuthHeader): Boolean
suspend fun refreshToken(response: HttpResponse): Boolean
val sendWithoutRequest: Boolean
fun sendWithoutRequest(request: HttpRequestBuilder): Boolean

class BearerAuthConfig

BearerAuthConfig()
fun loadTokens(block: suspend () -> BearerTokens?): Unit
var realm: String?
fun refreshTokens(block: suspend (response: HttpResponse) -> BearerTokens?): Unit
fun sendWithoutRequest(block: (HttpRequestBuilder) -> Boolean): Unit

class BearerAuthProvider : AuthProvider

BearerAuthProvider(refreshTokens: suspend (response: HttpResponse) -> BearerTokens?, loadTokens: suspend () -> BearerTokens?, sendWithoutRequestCallback: (HttpRequestBuilder) -> Boolean = { true }, realm: String?)
suspend fun addRequestHeaders(request: HttpRequestBuilder): Unit
suspend fun clearToken(): Unit
fun isApplicable(auth: HttpAuthHeader): Boolean
suspend fun refreshToken(response: HttpResponse): Boolean
val sendWithoutRequest: Boolean
fun sendWithoutRequest(request: HttpRequestBuilder): Boolean

class BearerTokens

BearerTokens(accessToken: String, refreshToken: String)
val accessToken: String
val refreshToken: String

class DigestAuthConfig

DigestAuthConfig()
var algorithmName: String
fun credentials(block: suspend () -> DigestAuthCredentials?): Unit
var password: String
var realm: String?
var username: String

class DigestAuthCredentials

DigestAuthCredentials(username: String, password: String)
val password: String
val username: String

class DigestAuthProvider : AuthProvider

DigestAuthProvider(username: String, password: String, realm: String? = null, algorithmName: String = "MD5")
DigestAuthProvider(credentials: suspend () -> DigestAuthCredentials?, realm: String? = null, algorithmName: String = "MD5")
suspend fun addRequestHeaders(request: HttpRequestBuilder): Unit
val algorithmName: String
fun isApplicable(auth: HttpAuthHeader): Boolean
val password: String
val realm: String?
suspend fun refreshToken(response: HttpResponse): Boolean
val sendWithoutRequest: Boolean
fun sendWithoutRequest(request: HttpRequestBuilder): Boolean
val username: String

fun Auth.basic(block: BasicAuthConfig.() -> Unit): Unit
fun Auth.bearer(block: BearerAuthConfig.() -> Unit): Unit
fun Auth.digest(block: DigestAuthConfig.() -> Unit): Unit