ktor-server-auth/io.ktor.server.auth/AuthenticationStrategy

AuthenticationStrategy

enum AuthenticationStrategy : Enum<AuthenticationStrategy> (source)

A resolution strategy for nested authentication providers. AuthenticationStrategy.Optional - if the client provides no authentication, a call continues but with a null Principal. AuthenticationStrategy.FirstSuccessful - client must provide authentication data for at least one provider registered for this route AuthenticationStrategy.Required - client must provide authentication data for all providers registered for this route with this strategy

Report a problem

Entries

Optional

FirstSuccessful

Required

Properties

entries

val entries: EnumEntries<AuthenticationStrategy>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

expect val name: String

ordinal

expect val ordinal: Int

Functions

valueOf

fun valueOf(value: String): AuthenticationStrategy

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<AuthenticationStrategy>

Returns an array containing the constants of this enum type, in the order they're declared.