ktor-openapi-schema/io.ktor.openapi/Security/Builder

Builder

class Builder(source)

Builder for collecting security requirements for an operation.

Report a problem

Constructors

constructor()

Properties

val requirements: List<Map<String, List<String>>>

The collected list of security requirement objects.

Functions

fun apiKey(name: String)

Adds an API key requirement using the given parameter name.

fun basic()

Adds an HTTP Basic authentication requirement.

fun oauth2(vararg scopes: String)

Adds an OAuth 2 requirement with optional scopes.

fun openIdConnect(vararg scopes: String)

Adds an OpenID Connect requirement with optional scopes.

Marks security as optional by adding an empty requirement object. This allows requests without any authentication to succeed.

fun requirement(schemes: Map<String, List<String>>)

Adds a security requirement with multiple schemes that must all be satisfied (AND relationship). Use this when multiple authentication schemes must be used simultaneously. Each call to this method creates an OR relationship (alternative).

fun requirement(scheme: String, scopes: List<String> = emptyList())

Adds a security requirement for the given scheme and scopes. Each call to this method creates an OR relationship (alternative).