ktor-auth / io.ktor.auth / AuthenticationProvider

AuthenticationProvider

open class AuthenticationProvider

Represents an authentication provider with the given name

Types

Configuration

open class Configuration

Authentication provider configuration base class

Constructors

<init>

AuthenticationProvider(name: String? = null)AuthenticationProvider(config: Configuration)

Represents an authentication provider with the given name

Properties

name

val name: String?

Provider name or null for a default provider

pipeline

val pipeline: AuthenticationPipeline

Authentication pipeline for this provider

skipWhen

val skipWhen: List<ApplicationCallPredicate>

Authentication filters specifying if authentication is required for particular ApplicationCall

Functions

skipWhen

fun skipWhen(predicate: (ApplicationCall) -> Boolean): Unit

Adds an authentication filter to the list

Inheritors

BasicAuthenticationProvider

class BasicAuthenticationProvider : AuthenticationProvider

Represents a Basic authentication provider

DigestAuthenticationProvider

class DigestAuthenticationProvider : AuthenticationProvider

Represents a Digest authentication provider

FormAuthenticationProvider

class FormAuthenticationProvider : AuthenticationProvider

Represents a form-based authentication provider

OAuthAuthenticationProvider

class OAuthAuthenticationProvider : AuthenticationProvider

Represents an OAuth provider for Authentication feature

SessionAuthenticationProvider

class SessionAuthenticationProvider<T : Any> : AuthenticationProvider

Represents a session-based authentication provider