Class: SystemSettings
Defined in: auth/src/models/types.ts:463
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.
Extended by
Constructors
Constructor
new SystemSettings(
other?):SystemSettings
Defined in: auth/src/models/types.ts:495
Parameters
other?
Partial<SystemSettings>
Returns
SystemSettings
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").
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").
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).