ktor-server-auth/io.ktor.server.auth/BearerAuthenticationProvider

BearerAuthenticationProvider

class BearerAuthenticationProvider : AuthenticationProvider(source)

A Bearer Authentication provider.

Report a problem

See also

Types

class Config(name: String?, description: String? = null) : AuthenticationProvider.Config

A configuration for the bearer authentication provider.

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

open suspend override 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.