ktor-client-auth/io.ktor.client.plugins.auth/Auth

Auth

class Auth

A client's plugin that handles authentication and authorization. Typical usage scenarios include logging in users and gaining access to specific resources.

You can learn more from Authentication and authorization.

providers - list of auth providers to use.

Types

Plugin

object Plugin : HttpClientPlugin<Auth, Auth>

Properties

providers

val providers: MutableList<AuthProvider>

Extensions

basic

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

Installs the client's BasicAuthProvider.

bearer

fun Auth.bearer(block: BearerAuthConfig.() -> Unit)

Installs the client's BearerAuthProvider.

digest

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

Installs the client's DigestAuthProvider.