Skip to main content

mfa — module reference

Rendered from the module's own manifest, and from nothing written by hand. What the module does is its own page.

Module idmfa
NameMFA
Version1.0.0
Ships from@endora-commerce/mod-mfa
LicenceMIT

Activation​

An operator switches this module on and off on /platform/modules. The choice is the setting mfa.enabled, and it defaults to on.

Dependencies​

ModuleBindingWhat it means
admin_rolesyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
admin_usersyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
authyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
customer_accountsyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
organizationsyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
settingsyesinstalls and migrates after it, and an operator cannot switch it off underneath this module

Permissions​

CodeLabelAlso needs
mfa:manageManage two-step verification policies and organization enforcement—
mfa:resetReset a user's two-step verification—

Command palette​

ActionOpensPermission
open-security/security—

Settings​

CodeNameType
mfa.admin.google_enabledAdmin UI — Google sign-inboolean
mfa.admin.microsoft_enabledAdmin UI — Microsoft sign-inboolean
mfa.admin.totp_enabledAdmin UI — allow two-step verificationboolean
mfa.admin.totp_enforcedAdmin UI — enforce two-step verificationboolean
mfa.enabledMFA enabledboolean
mfa.storefront.google_enabledStorefront — Google sign-inboolean
mfa.storefront.microsoft_enabledStorefront — Microsoft sign-inboolean
mfa.storefront.totp_enabledStorefront — allow two-step verificationboolean
mfa.storefront.totp_enforcedStorefront — enforce two-step verificationboolean

Translations​

Bundles at i18n inside the module, one file per shipped language.

Operator commands​

None.