Skip to main content

Interface: RefreshTokenStore

Defined in: auth-core/src/oauthServerTypes.ts:185

App-provided store for refresh tokens, backing OAuth 2.1 rotation. The store is pure persistence — the rotation mechanics (single-use, expiry, reuse detection) live in createRefreshRotation. Back it with DynamoDB, Postgres, in-memory, … The "owner" of a token is the (clientId, subject) pair.

Properties​

delete​

delete: (tokenHash) => void | Promise<void>

Defined in: auth-core/src/oauthServerTypes.ts:193

Remove a single refresh token by its hash.

Parameters​

ParameterType
tokenHashstring

Returns​

void | Promise<void>


deleteByOwner​

deleteByOwner: (owner) => void | Promise<void>

Defined in: auth-core/src/oauthServerTypes.ts:198

Remove every refresh token belonging to an owner. Called on reuse detection to revoke the entire chain (the live token included), forcing re-auth.

Parameters​

ParameterType
owner{ clientId: string; subject: string; }
owner.clientIdstring
owner.subjectstring

Returns​

void | Promise<void>


get​

get: (tokenHash) => StoredRefreshToken | Promise<StoredRefreshToken | undefined> | undefined

Defined in: auth-core/src/oauthServerTypes.ts:189

Look up a refresh token by its hash. Return undefined if unknown.

Parameters​

ParameterType
tokenHashstring

Returns​

StoredRefreshToken | Promise<StoredRefreshToken | undefined> | undefined


save​

save: (token) => void | Promise<void>

Defined in: auth-core/src/oauthServerTypes.ts:187

Persist a refresh token, upserting by tokenHash.

Parameters​

ParameterType
tokenStoredRefreshToken

Returns​

void | Promise<void>