AuthenticationContext

An authentication context for a call.

call

instance of ApplicationCall this context is for.

Constructors

constructor(call: ApplicationCall)

All registered errors during auth procedure (only AuthenticationFailedCause.Error).

All authentication failures during auth procedure including missing or invalid credentials.

Retrieves an authenticated principal, or returns null if a user isn't authenticated.

Requests a challenge to be sent to the client if none of mechanisms can authenticate a user.

Appends an error to the errors list. Overwrites if already registered for the same key.

fun principal(principal: Any)

Sets an authenticated principal for this context.

inline fun <T : Any> principal(provider: String? = null): T?

Retrieves a principal of the type T from provider with name provider, if any.

fun principal(provider: String? = null, principal: Any)

Sets an authenticated principal for this context from provider with name provider.

fun <T : Any> principal(provider: String?, klass: KClass<T>): T?

Retrieves a principal of the type T, if any.