ktor-server-auth

3.3.0

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

Config

class Config(val name: String?) : AuthenticationProvider.Config(source)

A configuration for the bearer authentication provider.

Report a problem

Constructors

constructor(name: String?)

Properties

val name: String?

is the name of the provider, or null for a default provider.

var realm: String?

Specifies an options Bearer realm to be passed in WWW-Authenticate header.

Functions

fun authenticate(authenticate: suspend ApplicationCall.(BearerTokenCredential) -> Any?)

Exchanges the token for a Principal.

fun authHeader(getAuthHeader: (ApplicationCall) -> HttpAuthHeader?)

Retrieves an HTTP authentication header. By default, it parses the Authorization header content.

fun authSchemes(defaultScheme: String = AuthScheme.Bearer, vararg additionalSchemes: String)

Provide the auth schemes accepted when validating the authentication. By default, it accepts the "Bearer" scheme.

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

Adds an authentication filter to the list. For every application call the specified predicate is applied and if it returns true then the authentication provider is skipped (no auth required for this call with this provider).