ktor-client-auth/io.ktor.client.plugins.auth.providers/BasicAuthConfig

BasicAuthConfig

class BasicAuthConfig(source)

A configuration for BasicAuthProvider.

Report a problem

Constructors

BasicAuthConfig

constructor()

Properties

var cacheTokens: Boolean

Configures whether to cache the result of credentials.

lateinit var ~~password~~: String

Required: The password of the basic auth.

var realm: String?

(Optional) Specifies the realm of the current provider.

sendWithoutRequest

var ~~sendWithoutRequest~~: Boolean

Send credentials in without waiting for HttpStatusCode.Unauthorized.

lateinit var ~~username~~: String

Required: The username of the basic auth.

Functions

fun credentials(block: suspend () -> BasicAuthCredentials?)

Allows you to specify authentication credentials.

sendWithoutRequest

fun sendWithoutRequest(block: (HttpRequestBuilder) -> Boolean)

Sends credentials without waiting for HttpStatusCode.Unauthorized.