jin-frame / providers/security/BearerTokenProvider / BearerTokenProvider

Class: BearerTokenProvider

Defined in: packages/jin-frame/src/providers/security/BearerTokenProvider.ts:10

Bearer Token security provider for HTTP Bearer Token authentication. Automatically adds "Bearer " prefix to tokens if not already present. Call setKey() to update the token at runtime (e.g. after token refresh).

Implements

• SecurityProvider

Constructors

Constructor

new BearerTokenProvider(name): BearerTokenProvider

Defined in: packages/jin-frame/src/providers/security/BearerTokenProvider.ts:17

Parameters

name

string = 'bearer'

Returns

BearerTokenProvider

Properties

name

readonly name: string

Defined in: packages/jin-frame/src/providers/security/BearerTokenProvider.ts:13

Unique name for this security provider instance

Implementation of

SecurityProvider.name

---

type

readonly type: "http"

Defined in: packages/jin-frame/src/providers/security/BearerTokenProvider.ts:11

The type of security scheme (following OpenAPI 3.0 security scheme types)

Implementation of

SecurityProvider.type

Methods

createContext()

createContext(authorization?, dynamicKey?): SecurityContext

Defined in: packages/jin-frame/src/providers/security/BearerTokenProvider.ts:26

Create authentication context for the request

Parameters

authorization?

AuthorizationData

The authorization data configured in the frame

dynamicKey?

string

Dynamic key passed at runtime (takes precedence over authorization)

Returns

SecurityContext

Security context with headers, auth, and params to be applied to the request

Example

// Called with frame authorization
const context1 = provider.createContext('bearer-token');

// Called with dynamic key (overrides frame authorization)
const context2 = provider.createContext('frame-token', 'runtime-token');

Implementation of

SecurityProvider.createContext

---

setKey()

setKey(key): this

Defined in: packages/jin-frame/src/providers/security/BearerTokenProvider.ts:21

Parameters

key

string

Returns

this