Interface ApiKeyOptions

API key configuration options.

Since

0.1.0

interface ApiKeyOptions {
header?: string;
validate: (key: string) => Promise<IPrincipal | null>;
}

Index

Properties

header? validate

Properties

`Optional` `Readonly`header

header?: string

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

`Readonly`validate

validate: (key: string) => Promise<IPrincipal | null>

Callback to validate the API key and return a principal. Return null if the key is invalid.