http4k-contract/org.http4k.contract.security

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, val scopes: List<OAuthScope> = emptyList(), val filter: Filter, val name: String = "oauthSecurityAuthCode", val refreshUrl: Uri? = null, val 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 ImplicitOAuthSecurity(val authorizationUrl: Uri, val scopes: List<OAuthScope> = emptyList(), val filter: Filter, val name: String = "oauthSecurityImplicit", val refreshUrl: Uri? = null, val extraFields: Map<String, String> = emptyMap()) : OAuthSecurity

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, val scopes: List<OAuthScope> = emptyList(), val filter: Filter = Filter.NoOp, val name: String = "oauthSecurityUserCredentials", val refreshUrl: Uri? = null, val extraFields: Map<String, String> = emptyMap()) : OAuthSecurity