ApiClient
Table of Contents
Classes
- ApiClientAuthentication
- Result of verifying an application key: the status and, for a valid key, the client identity.
- ApiClientContext
- External Api client whose key came with the request being processed right now.
- ApiClientIdentity
- Verified external Api client for one request: who it is, which roles may be applied through it
and its limits (`null` means the default from `api.clientKey.limits`).
- ApiClientKey
- Shape of an application key for the external Api: a recognizable prefix plus 32 random bytes
(64 hex characters).
- ApiClientKeyConfig
- Application key settings (`parameters.api.clientKey` in `config/Shared/api.neon`).
- ApiClientLimitResult
- Result of an application key limit check. For an exceeded limit it carries the window that
caused it, `Retry-After` (seconds to the end of the window, at least 1) and whether this is
the first refusal in the window; only that one is written to the auth log, so a flood does not
flood the log too.
- ApiClientRateLimiter
- Request limits per application key.
Enums
- ApiClientKeyStatus
- Result of verifying an application key. The caller gets the same response (401) for every
failure; the distinction serves only the auth log, so the operator can see why an application
was refused.