zero-auth

Appearance

zero-auth API Documentation v1.6.0

zero-auth API Documentation / RedisRevocationStore

Interface: RedisRevocationStore ​

Defined in: packages/zero-auth/src/refresh/redisRevocationStore.ts:27

Application-owned store for concurrency-safe refresh-token rotation. consume() must atomically return true only for the first use of a jti.

Extends ​

Methods ​

consume() ​

consume(jti, context?): boolean | Promise<boolean>

Defined in: packages/zero-auth/src/types/auth.ts:186

Parameters ​

jti ​

string

context? ​

RefreshTokenContext

Returns ​

boolean | Promise<boolean>

Inherited from ​

RefreshTokenStore.consume

isRevoked() ​

isRevoked(jti): Promise<boolean>

Defined in: packages/zero-auth/src/refresh/redisRevocationStore.ts:31

Check whether a jti is currently revoked.

Parameters ​

jti ​

string

Returns ​

Promise<boolean>

register()? ​

optional register(jti, context): void | Promise<void>

Defined in: packages/zero-auth/src/types/auth.ts:187

Parameters ​

jti ​

string

context ​

RefreshTokenContext

Returns ​

void | Promise<void>

Inherited from ​

RefreshTokenStore.register

revoke() ​

revoke(jti, familyId?): Promise<void>

Defined in: packages/zero-auth/src/refresh/redisRevocationStore.ts:29

Mark a jti as revoked; optionally associate it with a token family.

Parameters ​

jti ​

string

familyId? ​

string

Returns ​

Promise<void>

revokeFamily() ​

revokeFamily(familyId): Promise<void>

Defined in: packages/zero-auth/src/refresh/redisRevocationStore.ts:33

Revoke every known jti in a token family.

Parameters ​

familyId ​

string

Returns ​

Promise<void>

Overrides ​

RefreshTokenStore.revokeFamily