Structs§
- ApiKey
Callback Context - Immutable application context for trusted API-key lookup and validation.
- ApiKey
Config - Configuration for the API Key plugin, aligned with the TypeScript
ApiKeyOptions. - ApiKey
Error Details - Additional information returned when a key reaches its rate limit.
- ApiKey
Generation Options - Inputs passed to an application key generator; length excludes the prefix.
- ApiKey
Plugin - API Key management plugin.
- ApiKey
Plugin Builder - Use builder syntax to set the inputs and finish with
build(). - ApiKey
Validation Error - An API key rejection with the upstream error code and response fields.
- ApiKey
Verification Input - Input to the registered server-only verification operation.
- ApiKey
Verification Output - Create
KeyRequest - API key creation parameters for HTTP and trusted server callers.
- Create
KeyResponse - Newly issued API key. The plaintext key is only returned during creation.
- Delete
Expired ApiKeys Response - Result of trusted forced expiration cleanup. Store failures are logged.
- KeyExpiration
Config - Key expiration constraints.
- Rate
Limit Defaults - Global rate-limit defaults applied to newly-created keys.
- Update
KeyRequest - API key updates for HTTP and trusted server callers.
- Verify
ApiKey - Inputs for server-only API key verification. Verification consumes one use.
Enums§
- ApiKey
Error Code - Dedicated API Key error codes aligned with the TypeScript
API_KEY_ERROR_CODES. - ApiKey
Error Message - Upstream verification messages can contain either text or an error-code object.
- ApiKey
References - Which kind of entity a configuration’s keys belong to.
- ApiKey
Storage Mode - API-key persistence policy. Secondary-only admission is a non-atomic merge; use database fallback for durable, guarded quota and rate-limit admission.
- ApiKey
Verification Error - Distinguishes a rejected credential from a storage or infrastructure failure.
Traits§
- ApiKey
Default Permissions - Trusted dynamic defaults, evaluated even when creation supplies an override.
- ApiKey
Generator - Trusted custom secret generation. The application owns the returned full key.
- ApiKey
Getter - Application lookup replaces configured API-key headers entirely.
- ApiKey
Storage - Application-owned serialized API-key storage.
NoneTTL means permanent. Implementations must propagate failures; these operations are not atomic admission. - ApiKey
Validator - Trusted acceptance predicate, evaluated before key usage is consumed.
Type Aliases§
- ApiKey
Permissions - Ordered resource/action permissions, following JavaScript object insertion order.