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

requirement

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

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

Report a problem

Parameters

scheme

The name of the security scheme.

scopes

Optional list of scopes required for the scheme.

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

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

Report a problem

Parameters

schemes

A map of scheme names to their required scopes.