Package-level declarations

Types

Checks the presence of the named Api Key parameter. Filter returns 401 if Api-Key is not found in request.

class AuthCodeOAuthSecurity(val authorizationUrl: Uri, val tokenUrl: Uri, scopes: List<OAuthScope> = emptyList(), filter: Filter, name: String = "oauthSecurityAuthCode", refreshUrl: Uri? = null, extraFields: Map<String, String> = emptyMap()) : OAuthSecurity

class BearerAuthSecurity(val filter: Filter, val name: String = "bearerAuth") : Security

Checks the presence of bearer auth credentials. Filter returns 401 if auth fails.

class ClientCredentialsOAuthSecurity(val tokenUrl: Uri, scopes: List<OAuthScope> = emptyList(), filter: Filter = Filter.NoOp, name: String = "oauthSecurityClientCredentials", refreshUrl: Uri? = null, extraFields: Map<String, String> = emptyMap()) : OAuthSecurity

class DeviceCodeOAuthSecurity(val deviceAuthorizationUrl: Uri, val tokenUrl: Uri, scopes: List<OAuthScope> = emptyList(), filter: Filter = Filter.NoOp, name: String = "oauthSecurityDeviceCode", refreshUrl: Uri? = null, extraFields: Map<String, String> = emptyMap()) : OAuthSecurity

class ImplicitOAuthSecurity(val authorizationUrl: Uri, scopes: List<OAuthScope> = emptyList(), filter: Filter, name: String = "oauthSecurityImplicit", refreshUrl: Uri? = null, extraFields: Map<String, String> = emptyMap()) : OAuthSecurity

class MutualTLSSecurity(val filter: Filter = Filter.NoOp, val name: String = "mutualTLS") : Security

Mutual TLS (client certificate) security. The mTLS handshake is enforced at the transport/server layer, so the filter defaults to a no-op.

data class Nonce(val value: String)

Default NoOp security filter. Filter allows all traffic through.

data class OAuthScope(val name: String, val description: String = name)

class OpenIdConnectSecurity(val discoveryUrl: Uri, val filter: Filter, val name: String = "openIdConnect") : Security

interface Security

Endpoint security. Provides filter to be applied to endpoints for all requests.

class UserCredentialsOAuthSecurity(val tokenUrl: Uri, scopes: List<OAuthScope> = emptyList(), filter: Filter = Filter.NoOp, name: String = "oauthSecurityUserCredentials", refreshUrl: Uri? = null, extraFields: Map<String, String> = emptyMap()) : OAuthSecurity