Skip to main content

Interface: Secret

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

Describes a single authentication secret associated with a specific user account. A secret is used to authenticate the user with the system.

Supported types of secrets:

  • app-password
  • fido2
  • openid
  • password
  • passkey
  • recovery-codes
  • totp

Extends​

  • BaseEntity

Properties​

data​

data: any

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

The data associated with the secret.

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

hint?​

optional hint?: string

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

A short textual description that gives the user a hint about what the secret is.

lastUsedAt?​

optional lastUsedAt?: string

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

The ISO-8601 timestamp of the last time this secret was used to successfully authenticate; unset if it never has been.

type​

type: SecretType

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

The type of secret (e.g. fido2, openid, password, passkey, totp)

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

userUid​

userUid: string

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

The unique identifier of the user account this secret is associated with.

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