Connectum API Reference / @connectum/auth / GatewayAuthInterceptorOptions

Interface: GatewayAuthInterceptorOptions

Defined in: packages/auth/src/types.ts:301

Gateway auth interceptor options.

For services behind an API gateway that has already performed authentication. Extracts auth context from gateway-injected headers.

Properties

defaultType?

readonly optional defaultType: string

Defined in: packages/auth/src/types.ts:318

Default credential type when not provided by gateway

---

headerMapping

readonly headerMapping: GatewayHeaderMapping

Defined in: packages/auth/src/types.ts:303

Mapping from AuthContext fields to gateway header names

---

propagateHeaders?

readonly optional propagateHeaders: boolean

Defined in: packages/auth/src/types.ts:316

Propagate auth context as headers for downstream services

---

skipMethods?

readonly optional skipMethods: string[]

Defined in: packages/auth/src/types.ts:314

Methods to skip authentication for

---

stripHeaders?

readonly optional stripHeaders: string[]

Defined in: packages/auth/src/types.ts:312

Headers to strip from the request after extraction (prevent spoofing)

---

trustSource

readonly trustSource: object

Defined in: packages/auth/src/types.ts:305

Trust verification: check that request came from a trusted gateway

expectedValues

readonly expectedValues: string[]

Accepted values for the trust header

header

readonly header: string

Header set by the gateway to prove trust