Skip to end of metadata
Go to start of metadata

Overview
 

Two-factor authentication (2FA) is mandatory for CMS logins. The user is required to enter their password and verify the login through a PIN (passcode) from an authenticator app on their personal device. This two step procedure aims to ensure that the person logging into the CMS is the owner of that account.


On this page:

For CMS Users

You will be required to set up 2FA when you next attempt to login to CMS.


Initial Authentication Setup


To use two-factor authentication, you must have the following ready:

  • an authenticating device: this is usually a personal device you have access to during the login process, e.g., your smartphone, 
  • an authenticator app installed on your authenticating device.

There are a number of free third party Authenticator apps that you can easily download to your personal devices. Some popular ones are Google Authenticator, Authy and Microsoft Authenticator.
NOTE - The authenticating procedure may vary slightly for different apps but they all involve scanning a QR Code or manually entering an entry key, and then obtaining the authentication PIN for login.  


Procedure: 

  1. At the CMS login screen, enter your Username and Password, then click Login

  2. Instead of being logged in, the Authentication popup displays. 
  3. Open the authenticator app on your authenticating device.

  4. Either scan the QR Code or type in the Manual Entry Key. NOTE - if the 'Manual Entry Key' option is used, ensure 'Time-Based' is selected if you are asked to select a 'Type of Key' option.

  5. The authenticator app generates a PIN that expires in a set amount of time. Enter this PIN in the Authentication popup.

  6. Click Verify and Login. If the PIN is valid, access to CMS will be granted. 

Subsequent Logins

  • Once you have successfully set their 2FA, the authenticator app saves the account for CMS login. At the next login, you simply open the authenticator app in your device to obtain a valid PIN. This PIN is entered after the Username/Password step. 

Failed Logins

  • You have five attempts at logging in. After the fifth failed attempt, you will be locked out for an hour.  

    Under certain circumstances, you receive an error message that the PIN is invalid.

    There are several reasons that could have caused it:

    • You have not set up the 2FA correctly
    • You entered an incorrect PIN.
    • If not one of the above, the next most likely cause that the PIN you entered has expired. 
      When a PIN is generated, it is current for a 30 second block based on UTC time. The UTC time is based on the time on your device. The PIN you entered must have been generated between 5 minutes before current time and 5 minutes after current time. This means your phone time must be quite close to the time on the server, if not exactly. If let's say you set your phone time 10 minutes ahead of actual time, the PIN you entered may not be accepted. 


Reset 2FA by User

  • An authenticated User can reset and set up a new authentication when logged in CMS. To reset authentication, they just follow the steps for User Reset for 2FA. Once the procedure is completed, the new authentication will automatically replace the old one. 



Password Changes

  • When two-factor authentication is active for the User, a Password change by the User must be authorised by entering a valid PIN.

To change the CMS password,

  1. While logged into CMS, hover over the icon on the top right corner of the screen.

  2. In the menu displayed, select Manage Account.


  3. In the 'Change Password' panel, enter the Current/New Password details. 
     

  4. In Two-Factor Authentication Required, enter a valid PIN obtained from the authenticator app.

  5. Click Change Password.

Resetting your 2FA

  • A User can reset 2FA for their CMS login. They must be logged into the CMS at the time.
  1. In the CMS, hover over the icon on the top right corner of the screen.

  2. In the menu displayed, select Manage Account.
     

  3. In the Manage Account screen, click the Two-Factor Authentication Setup button.  
  4. In the Setup Two-Factor Authentication screen, you will see a generated 'Manual Entry Key' and a 'QR Code'. 


  5. In your authenticating device, open the authenticator app and either scan the QR Code or type in the Manual Entry Key. NOTE - if the 'Manual Entry Key' option is used, ensure 'Time-Based' is selected if you are asked to select a 'Type of Key' option.

  6. The Authenticator app will generate a PIN. Enter this PIN in Verify Setup by Entering Authenticator App PIN.

  7. Click Verify and Save. If the PIN is valid, setup is successful and you will be logged into CMS. NOTE - A popup error message will display if the PIN is invalid.  

For Administrators

Reset 2FA by Admin

CMS Administrators and Commerce Vision can clear the current authentication set up by a User by resetting the User's authentication. This step is required if forced two-factor authentication is to be disabled for a User or the User has lost access to their current authentication.


To reset a User's authentication,

  1. Navigate to UsersCMS Users.

  2. Use the User Search tool to find the specific User and click Edit.

  3. Scroll down to the Two-Factor Authentication (2FA) section.

  4. When a User has a current authentication set up, the Reset Two-Factor Authentication for User button will appear. 
  5. Click the Reset Two-Factor Authentication for User button. 
  6. In the Reset Two-Factor Authentication popup, click OK to confirm you want to delete the current authentication.    

Force two-factor authentication on a User

NOTE - This section only applies if 2FA is not globally active.


CMS Administrators can make two-factor authentication mandatory (forced) for Users. Forced authentication must be enabled for each User individually as the global setting is OFF. 


To enable two-factor authentication for a User,

  1. Navigate to UsersCMS Users.

  2. Use the User Search tool to find the User and click Edit

  3. Scroll down to the Two-Factor Authentication (2FA) section.

  4. Toggle ON Override Global 2FA Configuration.



  5. Once Override Global 2FA Configuration is on, the Enable 2FA Configuration for User toggle will display. Toggle this ON. 

  6. To save the setting, click Save & Exit.

  7. When a user has set up their authentication, Administrators will see a red Reset two factor Authentication for User button in the Two-Factor Authentication (2FA) section.





Disabling forced authentication

Administrators can disable forced authentication for a User by toggling OFF Override Global 2FA Configuration and Enable 2FA Configuration for User and saving the change. However, if the User has set up a current authentication, the system will not permit disabling until the authentication has been cleared (reset).  

Related help