Connectum API Reference / @connectum/auth / SessionAuthInterceptorOptions

Interface: SessionAuthInterceptorOptions

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

Session-based auth interceptor options.

Two-step authentication: verify session token, then map session data to AuthContext.

Properties

cache?

readonly optional cache?: CacheOptions

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

LRU cache for session verification results

---

extractToken?

readonly optional extractToken?: (req) => string | Promise<string | null> | null

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

Custom token extraction. Default: extracts Bearer token from Authorization header.

Parameters

req

header

Headers

Returns

string | Promise<string | null> | null

---

mapSession

readonly mapSession: (session) => AuthContext | Promise<AuthContext>

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

Map raw session data to AuthContext.

Parameters

session

unknown

Raw session data from verifySession

Returns

AuthContext | Promise<AuthContext>

Normalized auth context

---

propagatedClaims?

readonly optional propagatedClaims?: string[]

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

Filter which claims are propagated in headers. When set, only listed claim keys are included in x-auth-claims header. When not set, all claims are propagated.

---

propagateHeaders?

readonly optional propagateHeaders?: boolean

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

Propagate auth context as headers for downstream services

---

skipMethods?

readonly optional skipMethods?: string[]

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

Methods to skip authentication for

---

verifySession

readonly verifySession: (token, headers) => unknown

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

Verify session token and return raw session data. Must throw on invalid/expired sessions.

Parameters

token

string

Session token string

headers

Headers

Request headers (for additional context)

Returns

unknown

Raw session data