Module api_key

Structs§

ApiKeyConfig: Configuration for the API Key plugin, aligned with the TypeScript ApiKeyOptions.
ApiKeyEndpoint: Endpoint data available to application API key callbacks.
ApiKeyErrorDetails: Additional information returned when a key reaches its rate limit.
ApiKeyPlugin: API Key management plugin.
ApiKeyPluginBuilder: Use builder syntax to set the inputs and finish with build().
ApiKeyValidationError: An API key rejection with the upstream error code and response fields.
CreateKeyRequest: API key creation parameters for HTTP and trusted server callers.
CreateKeyResponse: Newly issued API key. The plaintext key is only returned during creation.
KeyExpirationConfig: Key expiration constraints.
RateLimitDefaults: Global rate-limit defaults applied to newly-created keys.
UpdateKeyRequest: API key updates for HTTP and trusted server callers.
VerifyApiKey: Inputs for server-only API key verification. Verification consumes one use.

ApiKeyErrorCode: Dedicated API Key error codes aligned with the TypeScript API_KEY_ERROR_CODES.
ApiKeyErrorMessage: An API key rejection with the upstream error code and response fields.
ApiKeyReferences: Which kind of entity a configuration’s keys belong to.
ApiKeyStorage: Persistence used by an API Key configuration.
ApiKeyVerificationError: Distinguishes a rejected credential from a storage or infrastructure failure.

ApiKeyDefaultPermissions: Dynamic creation permissions. Explicit permissions still cause this callback to run.
ApiKeyGenerator: Application credential generation, before hashing and starting-character storage.
ApiKeyGetter: Synchronous key extraction used by the session hook matcher and handler.
ApiKeyValidator: Application validation before credential state and permission checks.