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

Package-level declarations

Types

AuthConfig

class AuthConfig

Configuration used by Auth plugin.

AuthProvider

interface AuthProvider

An authentication provider.

Properties

Auth

val Auth: ClientPlugin<AuthConfig>

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

AuthCircuitBreaker

val AuthCircuitBreaker: AttributeKey<Unit>

Shows that request should skip auth and refresh token procedure.

authProviders

val HttpClient.authProviders: List<AuthProvider>

Returns all auth providers configured for this client.

Functions

Auth

fun HttpClientConfig<*>.Auth(block: AuthConfig.() -> Unit)

Install Auth plugin.

authProvider

inline fun <T : AuthProvider> HttpClient.authProvider(): T?

Returns a single auth provider of the specified type, or null if not found or multiple providers exist.

clearAuthTokens

fun HttpClient.clearAuthTokens()

Clears cached tokens/credentials from all auth providers that support token clearing.