ktor-server-auth/io.ktor.server.auth/AuthenticationProvider

AuthenticationProvider

abstract class AuthenticationProvider(config: AuthenticationProvider.Config)(source)

An authentication provider with the specified name.

Report a problem

Inheritors

BasicAuthenticationProvider

BearerAuthenticationProvider

FormAuthenticationProvider

OAuthAuthenticationProvider

SessionAuthenticationProvider

DigestAuthenticationProvider

Constructors

AuthenticationProvider

constructor(config: AuthenticationProvider.Config)

Types

open class Config

Serves as the base class for authentication providers.

Properties

val description: String?

A description of the provider that can be used for API documentation.

val name: String?

A provider name or null for a default provider.

val skipWhen: List<ApplicationCallPredicate>

Authentication filters specifying if authentication is required for a particular ApplicationCall.

Functions

abstract suspend fun onAuthenticate(context: AuthenticationContext)

Authenticates a request based on AuthenticationContext. Implementations should either add a new AuthenticationContext.principal for successful authentication or register AuthenticationContext.challenge for failed ones.