Skip to main content

Interface: SystemSettingsEntity

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

Deployment-wide authentication policy that can be changed at runtime by an administrator. Stored as a single record (see SystemSettingsUtils), seeded from the server configuration the first time it is read.

Any field left undefined/null falls back to its corresponding @Config value.

Extends​

Properties​

allowMultiplePasswords​

allowMultiplePasswords: boolean = false

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

Set to true to let an account have more than one password secret, otherwise (the default) an account can have only one. With one, a password is the only way in by password, so whoever can change it — its holder, or an administrator who took it over by resetting it with allowUserChange=false — decides who can sign in that way. With several, sign-in accepts any of them, which is how an administrator keeps a password of their own on an account (one its holder can't change) alongside the holder's, to preserve their access to it.

Enforced when a password is created (see BaseSecretRoute.assertPasswordAllowed()); lowering it later doesn't remove passwords an account already has.

Seeded from and falls back to @Config("auth:allowMultiplePasswords").

Inherited from​

SystemSettings.allowMultiplePasswords

allowRegistration​

allowRegistration: boolean = true

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

Set to true to allow new accounts to be registered, otherwise set to false. When false, new accounts can only be created by a user with a trusted role.

Seeded from and falls back to @Config("auth:allowRegistration").

Inherited from​

SystemSettings.allowRegistration

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

requireMFA​

requireMFA: boolean = false

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

Set to true to force multi-factor authentication for every account regardless of its own requireMFA value (see BaseUserRoute.validateCreate/validateUpdate and AuthMFARoute, which drives MFAStrategyOptions.require2FA from this same flag).

Inherited from​

SystemSettings.requireMFA

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