Connectum API Reference / @connectum/auth / GatewayHeaderMapping

Interface: GatewayHeaderMapping

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

Header name mapping for gateway auth context extraction.

Maps AuthContext fields to custom header names used by the API gateway.

Properties

claims?

readonly optional claims: string

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

Header containing JSON-encoded claims

---

name?

readonly optional name: string

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

Header containing the display name

---

roles?

readonly optional roles: string

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

Header containing JSON-encoded roles array

---

scopes?

readonly optional scopes: string

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

Header containing space-separated scopes

---

subject

readonly subject: string

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

Header containing the authenticated subject

---

type?

readonly optional type: string

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

Header containing credential type