Two-Factor Authentication (2FA) Overview

Two-Factor Authentication (2FA) is an additional security layer that protects your EMQX Platform subaccounts. When 2FA is enabled, you'll need to enter a verification code generated by an authenticator app in addition to your username and password to log in.

Important Notes

• The 2FA feature described in this document only applies to EMQX Platform subaccounts, not the root user (administrator account).
• Subaccounts must be in an active state to configure 2FA. After configuration, a verification code is required for every login.
• Users who have already configured 2FA cannot set it up again.
• Please keep your authenticator app secure. Subaccounts cannot delete or reset 2FA on their own. Contact the root user if you need to delete it.
• Only the root user can delete 2FA. Subaccounts cannot perform this operation, even subaccounts with administrator privileges.
• Accounts with Single Sign-On (SSO) enabled cannot enable 2FA.

Configure Two-Factor Authentication

1. Log in to the EMQX Platform Console.
2. Click on your avatar in the top-right corner.
3. Find and click Two-Factor Authentication in the dropdown menu.
4. On the new page:
   • Download or use any authenticator app on your mobile device (such as Google Authenticator, Microsoft Authenticator, etc.).
   • Use the authenticator app to scan the QR code displayed on the page.
   • After successfully adding it to your authenticator app, enter the verification code to complete the setup.

It's recommended to test the login immediately after configuration to ensure the authenticator app is working properly.

Lost Authenticator Handling

If a sub-user loses their authenticator app, follow these steps:

1. Contact the root user.
2. The root user should locate the corresponding sub-account in the user management page.
3. Click on the Delete Two-Factor Authentication option.
4. After successful deletion, the sub-user can reconfigure 2FA.

Additional Notes

• Ensure you have a reliable network connection when configuring 2FA
• It's recommended to keep backups of your authenticator app on multiple devices
• Regularly check if your authenticator app is functioning properly
• If you change phones or uninstall the authenticator app, make sure to contact the root account administrator in advance