auth

Functions

<dl> <dt><a href="#createApiKey">createApiKey()</a></dt> <dd><p>Generate a new API key</p> </dd> <dt><a href="#listApiKeys">listApiKeys()</a></dt> <dd><p>List all API keys (masked)</p> </dd> <dt><a href="#getOnboardingState">getOnboardingState()</a></dt> <dd><p>Onboarding state helper</p> </dd> <dt><a href="#revokeApiKey">revokeApiKey()</a></dt> <dd><p>Revoke an API key</p> </dd> <dt><a href="#validateApiKeyJson">validateApiKeyJson()</a></dt> <dd><p>Validate API key</p> </dd> <dt><a href="#requireAuth">requireAuth()</a></dt> <dd><p>Auth middleware - check for valid API key and rate limit</p> </dd> <dt><a href="#optionalAuth">optionalAuth()</a></dt> <dd><p>Optional auth - doesn't block but tracks usage</p> <p>Validates API key and applies rate accounting when present, but never blocks the request. Use requireAuth() when auth must be enforced.</p> </dd> </dl>

<a name="createApiKey"></a>

createApiKey()

Generate a new API key

Kind: global function
<a name="listApiKeys"></a>

listApiKeys()

List all API keys (masked)

Kind: global function
<a name="getOnboardingState"></a>

getOnboardingState()

Onboarding state helper

Kind: global function
<a name="revokeApiKey"></a>

revokeApiKey()

Revoke an API key

Kind: global function
<a name="validateApiKeyJson"></a>

validateApiKeyJson()

Validate API key

Kind: global function
<a name="requireAuth"></a>

requireAuth()

Auth middleware - check for valid API key and rate limit

Kind: global function
<a name="optionalAuth"></a>

optionalAuth()

Optional auth - doesn't block but tracks usage

Validates API key and applies rate accounting when present, but never blocks the request. Use requireAuth() when auth must be enforced.

Kind: global function