Class RefreshTokenEntity

Description

Entity for a refresh token. This is used for refreshing access tokens. Refresh tokens are used to get new access tokens without having to re-authenticate.

Hierarchy

  • BaseMongoEntity
    • RefreshTokenEntity

Constructors

constructor

Properties

_id createdAt delFlg expiry id jti metadata updatedAt userId

Constructors

constructor

  • new RefreshTokenEntity(userId, jti, expiry, metadata): RefreshTokenEntity

  • Parameters

    • userId: string

      The id of the user this refresh token belongs to

    • jti: string

      An identifier for the refresh token (used when manually cancelling the session)

    • expiry: Date

      Expiry time for the refresh token

    • metadata: Record<string, unknown>

      Arbitrary metadata to store for the refresh token

    Returns RefreshTokenEntity

Properties

_id

_id: ObjectId

createdAt

createdAt: Date

delFlg

delFlg: 0 | 1

expiry

expiry: Date

Expiry time for the refresh token

id

id: string

jti

jti: string

An identifier for the refresh token (used when manually cancelling the session)

metadata

metadata: Record<string, unknown>

Arbitrary metadata to store for the refresh token

updatedAt

updatedAt: Date

userId

userId: string

The id of the user this refresh token belongs to

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc