Class: UserSecret

@acceleratxr/core_sdk / UserSecret

Class: UserSecret#

Provides a single method of authentication for a given user. A user may have multiple secrets tied to their user account. This makes it possible to handle multiple types of authentication methods such as password, multi-factor authentication, pre-shared key, device authentication and more.

Supported types:

  • apikey - An special alpha-numeric plain text secret used by exdternal applications and services.

  • device - A deterministic unique device hash or password used for frictionless device login.

  • mfa - A multi-factor authentication token used to strengthen the security of existing secrets. There can only be one secret of this type per user.

  • mfabackup - When mfa is used a series of mfabackup secrets are made as a one-time use recovery password.

  • password - A simple alpha-numeric plain text password. There can only one secret of this type per user.

REQUIRES: Account Services

author Jean-Philippe Steinmetz info@acceleratxr.com

Hierarchy#

Index#

Constructors#

Properties#

Accessors#

Constructors#

constructor#

+ new UserSecret(other?: any): UserSecret

Overrides EntityBase.constructor

Defined in src/models/UserSecret.ts:44

Parameters:#

Name

Type

other?

any

Returns: UserSecret

Properties#

dateCreated#

• dateCreated: Date = new Date()

Inherited from EntityBase.dateCreated

Defined in src/EntityBase.ts:18

The date and time that the object was created.

dateModified#

• dateModified: Date = new Date()

Inherited from EntityBase.dateModified

Defined in src/EntityBase.ts:23

The date and time that the object was last modified.

description#

• description: string | null = null

Defined in src/models/UserSecret.ts:29

A textual description of the secret that can be displayed to the user.

secret#

• secret: string = “”

Defined in src/models/UserSecret.ts:44

The underlying secret that is being stored.

type#

• type: string = “”

Defined in src/models/UserSecret.ts:39

The type of secret that is being stored.

uid#

• uid: string = uuid.v4()

Inherited from EntityBase.uid

Defined in src/EntityBase.ts:13

The universally unique identifier of the object.

userId#

• userId: string = “”

Defined in src/models/UserSecret.ts:34

The universally unique identifier of the user account associated with the secret.

version#

• version: number = 0

Inherited from EntityBase.version

Defined in src/EntityBase.ts:28

The optimistic locking version of the object.

Accessors#

ClassName#

• Staticget ClassName(): string

Defined in src/models/UserSecret.ts:24

Returns: string