DICE API Documentation/com.embabel.dice.web.rest.security/DiceApiKeyProperties

DiceApiKeyProperties

data class DiceApiKeyProperties(val enabled: Boolean = false, val keys: List<String> = emptyList(), val headerName: String = ApiKeyAuthenticator.DEFAULT_HEADER_NAME, val pathPatterns: List<String> = listOf("/api/v1/**"))

Configuration properties for DICE API key authentication.

Constructors

constructor(enabled: Boolean = false, keys: List<String> = emptyList(), headerName: String = ApiKeyAuthenticator.DEFAULT_HEADER_NAME, pathPatterns: List<String> = listOf("/api/v1/**"))

Properties

enabled

val enabled: Boolean = false

Enable API key authentication (default: false)

headerName

val headerName: String

Header name for the API key (default: X-API-Key)

keys

val keys: List<String>

List of valid API keys. For production, use a custom ApiKeyAuthenticator instead.

pathPatterns

val pathPatterns: List<String>

Path patterns to protect (default: /api/v1/ and subpaths)