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

Config

class Config : AuthenticationProvider.Config(source)

A configuration for the oauth authentication provider.

Report a problem

Properties

client

lateinit var client: HttpClient

An HTTP client instance used to make requests to the OAuth server.

description

val description: String?

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

fallback

var fallback: suspend ApplicationCall.(AuthenticationFailedCause.Error) -> Unit

Specifies a fallback function invoked when OAuth flow fails with an AuthenticationFailedCause.Error, e.g., a token exchange error, network/parse failure, etc. If call is not handled in the fallback, 401 Unauthorized will be responded.

name

val name: String?

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

providerLookup

var providerLookup: suspend ApplicationCall.() -> OAuthServerSettings??

A lookup function to find OAuth server settings for the particular call.

settings

var settings: OAuthServerSettings?

Static OAuth server settings. Either this or providerLookup should be specified.

urlProvider

lateinit var urlProvider: suspend ApplicationCall.(OAuthServerSettings) -> String

Specifies a redirect route opened when authorization is completed.

Functions

skipWhen

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).