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

BasicAuthConfig

class BasicAuthConfig
Content copied to clipboard

A configuration for BasicAuthProvider.

Constructors

Link copied to clipboard
fun BasicAuthConfig()
Content copied to clipboard

Functions

Link copied to clipboard
fun credentials(block: suspend () -> BasicAuthCredentials?)
Content copied to clipboard

Allows you to specify authentication credentials.

Link copied to clipboard
fun sendWithoutRequest(block: (HttpRequestBuilder) -> Boolean)
Content copied to clipboard

Sends credentials without waiting for HttpStatusCode.Unauthorized.

Properties

Link copied to clipboard
lateinit var password: String
Content copied to clipboard

Required: The password of the basic auth.

Link copied to clipboard
var realm: String? = null
Content copied to clipboard

(Optional) Specifies the realm of the current provider.

Link copied to clipboard
var sendWithoutRequest: Boolean = false
Content copied to clipboard

Send credentials in without waiting for HttpStatusCode.Unauthorized.

Link copied to clipboard
lateinit var username: String
Content copied to clipboard

Required: The username of the basic auth.