Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Get Started

Prerequisites

1. Setup Set up SMTP values in the Joget App for the email tool to be working properly.

Image Modified

Figure 1: SMTP Settings

Refer to Sign in with app passwords to generate the password for SMTP Gmail.


For more details, please refer to General Settings > SMTP Settings.  

...

Joget apps will ignore this global SMTP settings if the respective apps already has have the settings configured, either in the Plugin Default Properties or Email Tool - Configure SMTP Settings page.

...

2. Log in as admin, click on Settings in the admin bar, and navigate to Directory Manager Settings. (See Figure 4)

Image Modified 

Figure 4 :Directory Manager Settings

...

3.  Choose the Security Enhanced Directory Manager in the Select Plugin field and select OTP Email MFA Authenticator for the Multi-Factor Authenticator  Authenticator property. (See figure Figure 5)

Figure 5 : Multi Factor Authenticator

...

1. This configuration will determine the properties for of your OTP Email MFA Authenticator and the outcome of your plugin.
In General > Configure One-time Password Email MFA Authenticator

...

NameDescription
Validity Period (minute)Expiration The expiration time for the One Time Password (OTP) sent to the user's email registered in the profile to remain remains valid in minutes. The default value is 5 minutes.
SubjectThe subject of the email with the OTP.
Message

The message is to be displayed in the email.

...

NameDescription
HostKey in your mail server address, either via domain name or IP address. 
PortKey in your mail server port number.
SecurityKey in either TLS or SSL depending on your mail server.
UsernameKey in the sender's email username.
PasswordKey in the sender's email password
From Email AddressKey in the sender's email address to be shown to the recipient.

...


6. Before submitting the OTP Email MFA Authenticator, you may may click on Send Test Email to verify your Email configuration (See Figure 9)

...

8. Optionally, you may also activate all userusers to use OTP Email MFA Authenticator by default by adding their username as entries into the dir_user_meta table. 

Here's an sql SQL query where you can do so :

...

This query will add all the existing users in the dir_user table into the dir_user_meta table with the following values :

...

meta_value : enabled

The "where not existsexist" clause is to check and skip for existing users already having otp enabled.

...

3. A popup dialog will appear showing a Password field to submit the email OTP sent to the user. If the code is valid, OTP Email MFA will be activated (See Figure 11).

Figure 11: Password field to submit the email OTP sent to the user

...

1. As a user, you can disable OTP Email MFA Authenticator by clicking on the Deactivate button in your user profile. (See Figure 12)

Figure 12: Deactivate Deactivate 

2. Administrators can also disable MFA for a specific user by selecting the Setup Users under Users in the admin bar and clicking on the Deactivate MFA button. (See Figure 13)

...