ApiKeyAuthConfig

Defined in: packages/gateway/src/policies/auth/api-key-auth.ts:15

Configuration for the apiKeyAuth policy.

Extends

• PolicyConfig

Properties

forwardKeyIdentity?

optional forwardKeyIdentity?: object

Defined in: packages/gateway/src/policies/auth/api-key-auth.ts:37

After successful validation, derive an identity string from the key and set it as a request header for upstream consumption.

headerName

headerName: string

Header name to set on the request.

identityFn

identityFn: (key) => string | Promise<string>

Derive an identity string from the validated key. Can be async.

Parameters

key

string

Returns

string | Promise<string>

Example

apiKeyAuth({
  validate: (key) => keys.has(key),
  forwardKeyIdentity: {
    headerName: "x-api-client",
    identityFn: (key) => keyToClientMap.get(key) ?? "unknown",
  },
});

---

headerName?

optional headerName?: string

Defined in: packages/gateway/src/policies/auth/api-key-auth.ts:17

Header name to read the API key from. Default: “X-API-Key”

---

queryParam?

optional queryParam?: string

Defined in: packages/gateway/src/policies/auth/api-key-auth.ts:19

Query parameter name as fallback. Default: undefined (disabled)

---

skip?

optional skip?: (c) => boolean | Promise<boolean>

Defined in: packages/gateway/src/policies/types.ts:90

Skip this policy when condition returns true

Parameters

c

unknown

Returns

boolean | Promise<boolean>

Inherited from

PolicyConfig.skip

---

validate

validate: (key) => boolean | Promise<boolean>

Defined in: packages/gateway/src/policies/auth/api-key-auth.ts:21

Validator function - return true if the key is valid

Parameters

key

string

Returns

boolean | Promise<boolean>