APIAuthSchemeOptions

View Source

Summary

Options for creating an API-key auth scheme.

Signature

interface APIAuthSchemeOptions<identity> {
  headerName?: string;
  name?: string;
  verify(
    key: string,
    context: RequestContext,
  ): identity | Promise<identity | null> | null;
}

Properties

headerName

Request header that carries the API key.

name

Method name exposed on the resolved auth state.

Methods

verify(key: string, context: RequestContext): identity | Promise<identity | null> | null

Verifies a parsed API key and returns the resolved identity on success.

key

context