Class ApiKeyStrategy

Simple API key authentication strategy. Supports configurable header names for different service requirements.

Implements

IAuthStrategy

Index

Constructors

Methods

getAuthHeaders getHeaderName isUsingAuthorizationHeader

Constructors

constructor

new ApiKeyStrategy(apiKey: string, headerName?: string): ApiKeyStrategy
Creates a new API key authentication strategy.
Parameters
- apiKey: string
  The API key to use for authentication
- headerName: string = 'Authorization'
  The header name to use (defaults to 'Authorization')
Returns ApiKeyStrategy
- Defined in src/auth/ApiKeyStrategy.ts:13

Methods

getAuthHeaders

getAuthHeaders(): Promise<Record<string, string>>
Generates authentication headers for API key-based authentication. Uses Bearer token format for Authorization header, plain key for custom headers.

Returns Promise<Record<string, string>>
Promise resolving to authentication headers
Implementation of IAuthStrategy.getAuthHeaders
- Defined in src/auth/ApiKeyStrategy.ts:30

getHeaderName

getHeaderName(): string
Gets the configured header name for this strategy.

Returns string
The header name that will be used
- Defined in src/auth/ApiKeyStrategy.ts:43

isUsingAuthorizationHeader

isUsingAuthorizationHeader(): boolean
Checks if this strategy uses the standard Authorization header.

Returns boolean
True if using Authorization header, false for custom headers
- Defined in src/auth/ApiKeyStrategy.ts:51