Member Junction
    Preparing search index...

    Interface APIKeyEngineConfig

    Configuration for the API Key Engine

    interface APIKeyEngineConfig {
        defaultBehaviorNoScopes?: "allow" | "deny";
        enforcementEnabled?: boolean;
        keyGeneration?: APIKeyGenerationConfig;
        loggingEnabled?: boolean;
        scopeCacheTTLMs?: number;
    }
    Index

    Properties

    defaultBehaviorNoScopes? enforcementEnabled? keyGeneration? loggingEnabled? scopeCacheTTLMs?

    Properties

    defaultBehaviorNoScopes?: "allow" | "deny"

    Default behavior when key has no scopes (default: 'allow')

    enforcementEnabled?: boolean

    Whether scope enforcement is enabled (default: true)

    keyGeneration?: APIKeyGenerationConfig

    API key generation parameters (prefix, entropy, encoding, hash algorithm). WARNING: Changing these after keys exist will invalidate all existing keys.

    loggingEnabled?: boolean

    Whether to log all requests (default: true)

    scopeCacheTTLMs?: number

    Cache TTL in milliseconds for scope rules (default: 60000)

    Settings

    Member Visibility

    On This Page

    Properties