Skip to main content

Interface: SigningKey

Defined in: auth/src/models/types.ts:290

Defines a single asymmetric key pair used to sign tokens issued by this authorization server.

Extends​

  • BaseEntity

Properties​

activatedAt​

activatedAt: Date

Defined in: auth/src/models/types.ts:307

The date this key became ACTIVE.


alg​

alg: "RS256"

Defined in: auth/src/models/types.ts:295

The signing algorithm this key is used with.


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.

Inherited from​

BaseEntity.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.

Inherited from​

BaseEntity.dateModified


kid​

kid: string

Defined in: auth/src/models/types.ts:292

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


privateKeyEncrypted​

privateKeyEncrypted: string

Defined in: auth/src/models/types.ts:301

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


publicKeyJwk​

publicKeyJwk: any

Defined in: auth/src/models/types.ts:298

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


retiredAt?​

optional retiredAt?: Date

Defined in: auth/src/models/types.ts:310

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


status​

status: SigningKeyStatus

Defined in: auth/src/models/types.ts:304

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


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.

Inherited from​

BaseEntity.uid


version​

version: number

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

The optimistic lock version.

Inherited from​

BaseEntity.version