Skip to main content

Class: UserMongo

Defined in: auth/src/models/mongo/UserMongo.ts:39

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

Extends​

  • BaseMongoEntity

Implements​

Constructors​

Constructor​

new UserMongo(other?): UserMongo

Defined in: auth/src/models/mongo/UserMongo.ts:73

Parameters​

other?​

Partial<UserMongo>

Returns​

UserMongo

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

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​

User.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​

User.dateModified

Inherited from​

BaseMongoEntity.dateModified

passwordChangeRequired?​

optional passwordChangeRequired?: boolean

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

Set to true when the account holder must choose a new password before doing anything else — e.g. an administrator provisioned the account with a temporary password. Sign-in still succeeds, and the flag is reported to the client with the rest of the user so it can prompt for the change. Cleared automatically once the account holder changes their own password (see BaseSecretRoute.update()). Only a trusted user can set it.

Default value is false.

Implementation of​

User.passwordChangeRequired

requireMFA?​

optional requireMFA?: boolean

Defined in: auth/src/models/mongo/UserMongo.ts:43

Set to true to require multi-factor authentication for this account, otherwise set to false.

Default value is set by @Config("auth:requireMFA").

Implementation of​

User.requireMFA

roles​

roles: string[] = []

Defined in: auth/src/models/mongo/UserMongo.ts:55

The list of roles (by name) that the user is a member of and will inherit the permissions of.

Implementation of​

User.roles

scopes​

scopes: string[] = []

Defined in: auth/src/models/mongo/UserMongo.ts:59

The list of auth scopes that the user has been granted permission for.

Implementation of​

User.scopes

sessionsRevokedAt?​

optional sessionsRevokedAt?: number

Defined in: auth/src/models/mongo/UserMongo.ts:67

The epoch-millisecond timestamp (see Date.now()) at which every refresh token issued for this account before that moment was revoked (see BaseAccountRoute.revokeSessions()/BaseAuthRefreshRoute). A refresh token whose iat claim predates this is rejected. Does not affect already-issued access tokens, which remain valid until their own natural (short) expiry regardless — see revokeSessions()'s doc comment for why that's an inherent limitation, not an oversight.

Implementation of​

User.sessionsRevokedAt

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​

User.uid

Inherited from​

BaseMongoEntity.uid

verified​

verified: boolean = false

Defined in: auth/src/models/mongo/UserMongo.ts:71

Indicates if the user's e-mail address has been verified.

Implementation of​

User.verified

version​

version: number

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

The optimistic lock version.

Implementation of​

User.version

Inherited from​

BaseMongoEntity.version