ktor-client-auth-basic / io.ktor.client.features.auth.basic / BasicAuth

BasicAuth

class BasicAuth
Deprecated: [BasicAuth] deprecated, use [Auth] feature with [Basic] provider instead.

HttpClient feature that sets an Authorization: basic header as specified in RFC-2617 using username and password.

https://www.ietf.org/rfc/rfc2617.txt

Types

Configuration

class Configuration

Feature

companion object Feature : HttpClientFeature<Configuration, BasicAuth>

Constructors

<init>

BasicAuth(username: String, password: String)

HttpClient feature that sets an Authorization: basic header as specified in RFC-2617 using username and password.

Properties

password

val password: String

: user password.

username

val username: String

: user name.

Companion Object Properties

key

val key: AttributeKey<BasicAuth>

Companion Object Functions

constructBasicAuthValue

fun constructBasicAuthValue(username: String, password: String): String

Create basic auth header value from username and password.

install

fun install(feature: BasicAuth, scope: HttpClient): Unit

prepare

fun prepare(block: Configuration.() -> Unit): BasicAuth