Auth

class Auth

Client authentication feature. providers - list of auth providers to use.

Types

Feature

companion object Feature : HttpClientFeature<Auth, Auth>

Constructors

<init>

Auth(providers: MutableList<AuthProvider> = mutableListOf())

Client authentication feature. providers - list of auth providers to use.

Properties

providers

val providers: MutableList<AuthProvider>

Companion Object Properties

key

val key: AttributeKey<Auth>

The AttributeKey for this feature.

Companion Object Functions

install

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

Installs the feature class for a HttpClient defined at scope.

prepare

fun prepare(block: Auth.() -> Unit): Auth

Builds a TFeature by calling the block with a TConfig config instance as receiver.

Extension Functions

basic

fun Auth.basic(block: BasicAuthConfig.() -> Unit): Unit

Add BasicAuthProvider to client Auth providers.

digest

fun Auth.digest(block: DigestAuthConfig.() -> Unit): Unit

Install client DigestAuthProvider.