Skip to main content

Class: SigningKeyMongo

Defined in: auth/src/models/mongo/SigningKeyMongo.ts:44

Implementation of the SigningKey interface for storage in a MongoDB database. If SQL is desired, please use models.sql.SigningKeySQL instead.

Extends​

  • BaseMongoEntity

Implements​

Constructors​

Constructor​

new SigningKeyMongo(other?): SigningKeyMongo

Defined in: auth/src/models/mongo/SigningKeyMongo.ts:70

Parameters​

other?​

Partial<SigningKeyMongo>

Returns​

SigningKeyMongo

Overrides​

BaseMongoEntity.constructor

Properties​

_id?​

optional _id?: any

Defined in: auth/node_modules/@rapidrest/service-core/dist/types/models/BaseMongoEntity.d.ts:11

The internal unique identifier used by MongoDB.

Inherited from​

BaseMongoEntity._id

activatedAt​

activatedAt: Date

Defined in: auth/src/models/mongo/SigningKeyMongo.ts:64

The date this key became ACTIVE.

Implementation of​

SigningKey.activatedAt

alg​

alg: "RS256" = "RS256"

Defined in: auth/src/models/mongo/SigningKeyMongo.ts:51

The signing algorithm this key is used with.

Implementation of​

SigningKey.alg

dateCreated​

dateCreated: Date

Defined in: auth/node_modules/@rapidrest/service-core/dist/types/models/BaseEntity.d.ts:18

The date and time that the entity was created.

Implementation of​

SigningKey.dateCreated

Inherited from​

BaseMongoEntity.dateCreated

dateModified​

dateModified: Date

Defined in: auth/node_modules/@rapidrest/service-core/dist/types/models/BaseEntity.d.ts:22

The date and time that the entity was last modified.

Implementation of​

SigningKey.dateModified

Inherited from​

BaseMongoEntity.dateModified

kid​

kid: string = ""

Defined in: auth/src/models/mongo/SigningKeyMongo.ts:48

The key id, embedded in every token's kid header so a verifier can select the matching public key.

Implementation of​

SigningKey.kid

privateKeyEncrypted​

privateKeyEncrypted: string = ""

Defined in: auth/src/models/mongo/SigningKeyMongo.ts:57

The private half of the key pair, PEM-encoded and encrypted at rest (see SigningKeyUtils).

Implementation of​

SigningKey.privateKeyEncrypted

publicKeyJwk​

publicKeyJwk: any = {}

Defined in: auth/src/models/mongo/SigningKeyMongo.ts:54

The public half of the key pair, as a JWK — safe to serve directly from /jwks.json.

Implementation of​

SigningKey.publicKeyJwk

retiredAt?​

optional retiredAt?: Date

Defined in: auth/src/models/mongo/SigningKeyMongo.ts:68

The date this key was retired, if it has been.

Implementation of​

SigningKey.retiredAt

status​

status: SigningKeyStatus = SigningKeyStatus.ACTIVE

Defined in: auth/src/models/mongo/SigningKeyMongo.ts:61

Whether this key is currently used to sign new tokens, or only retained to verify old ones.

Implementation of​

SigningKey.status

uid​

uid: string

Defined in: auth/node_modules/@rapidrest/service-core/dist/types/models/BaseEntity.d.ts:14

The universally unique identifier of the entity.

Implementation of​

SigningKey.uid

Inherited from​

BaseMongoEntity.uid

version​

version: number

Defined in: auth/node_modules/@rapidrest/service-core/dist/types/models/BaseEntity.d.ts:26

The optimistic lock version.

Implementation of​

SigningKey.version

Inherited from​

BaseMongoEntity.version