Email Authentication

Jump to: How to Configure Email Authentication

Email Authentication Properties

Overview Section:

• Name - Sets the name of the feature in the experience. It is defaulted to Email Authentication but can be changed.
• Service Uri - This is an uneditable

• Login Page - Sets the Page experience users will be directed to when Authentication is turned on for a Page in the experience.
• On Success Redirect Page - Sets the Page experience users will be directed to after successfully logging into the experience.
• + Add New - This button opens a new window that allows Studio Users to add an Email List or Email Pattern.
  • Email List - This is used to connect to a user list stored in the Lumavate platform database. Studio Users do not have access to set up a user list in the platform database.
  • Email Pattern - This allows Studio Users to set up authorized domains or specific email addresses. 

  To configure, Studio Users need to name the Security Group and enter an allowed email or email domain. 
  
  To authorize all emails within an organization enter an asterisk before the email domain. For example, to authorize all Lumavate email addresses, enter: *@lumavate.com
  
  To authorize specific emails, enter them as a list separated by a comma with no additional spacing. For example: support@lumavate.com,hello@lumavate.com

• Invalid Token Text
• Expired Token Text - Requires the variable {{ renewLink }} be used.
• Already Used Token Text 
• Token Renewed Confirmation 
• No Invitation Notification 

• Subject - This is the subject line of the email that is sent when Email Verification is the selected Auth Type in the Email Authentication Component.
• Text Content - This is the text version of the email sent when Email Verification is the selected Auth Type in the Email Authentication Component. The variable {{ activationLink }} is required to be included in the email as it will provide the experience user with the necessary experience link. 
• HMTL Content - This is the HTML version of the email sent when Email Verification is the selected Auth Type in the Email Authentication Component. The variable {{ activationLink }} is required to be included in the email as it will provide the experience user with the necessary app link.
• Subject - This is the subject line of the email that is sent when Email and Access Code Verification is the selected Auth Type in the Email Authentication Component.
• Text Content - This is the text version of the email sent when Email and Access Code Verification is the selected Auth Type in the Email Authentication Component. The variable {{ activationCode }} is required to be included in the email as it will provide the app user with the necessary one-time code. 
• HTML Content - This is the HTML version of the email sent when Email and Access Code Verification is the selected Auth Type in the Email Authentication Component. The variable {{ activationCode }} is required to be included in the email as it will provide the experience user with the necessary one-time code. 

History Section:

Studio Users can view a CSV record of the last 1,000 activation emails that were sent to experience users. 

• Launch Admin- By clicking the Launch Admin button a new window will appear in your browser. Click the download button to download the last 1,000 activation emails sent in a CSV format. 

• Max Duration - How long, in seconds, the activation code or activation link sent to experience users is valid. The property's default setting is 300 (seconds), or 5 minutes.
• Max Duration - How long, in seconds, a user can remain logged into the app before they would be required to sign in again. The property's default setting is 2592000 (seconds), or 30 days. If a user clears their cache, they will be required to sign in again.
• Security Key - A unique alphanumeric identifier prepopulated when the Feature is added. Studio Users should not change or remove this security key.
• Allow Multiple Sessions - Toggles on or off whether experience users will be allowed to log into the app from multiple devices at once.
• Unique User per Activation - Toggles on or off a user's ability to have a unique profile per experience. This setting only applies when the Profile Feature and Email Authentication are used in the same experience.
• Profile Service Uri - This setting only applies when the Profile Feature and Email Authentication are used in the same app.

Email Authentication Component Properties

• Component Id - Sets the name of the Email Authentication Component in the app. The Component Id can be referenced using JavaScript to add more functionality to the app as needed.

• Auth Type

  Sets the authorization method from a dropdown with two options. Authorized email addresses are set up in the Email Authentication Feature within the Authentication Section.      

  • Email Verification - This option will email app users a secure link to access the app. The email sent to users is configured in the Email Authentication Feature, under the Email Template Section.
  • Email and Access Code Verification - This option will email app users a one-time code to enter into the app to gain access.  The email sent to users is configured in the Email Authentication Feature, under the Email Template Section.
• Theme Color - Sets the color of the button. There are two ways to set the Background Color: Click the Color Swatch to choose from the app’s Color Palette or enter the hex code in the text field.
• Button Text - Sets the text that appears in the button.

Email Authentication Placement Settings

• Column Start - Sets the column where the Component will start. 
• Column Span - Sets how many columns the Component will span. 
• Padding - (Left, Right, Top, and Bottom) Sets how much space will appear on the top, bottom, left, and right of the Component. When building a Page with multiple Components, the Padding will determine the overall spacing between Components.
• Display Mode - Sets how the Component is displayed. If Both is selected, the Component will always show. Both are the default option. If Optimal is selected, the Component will only show if the browser supports the experience. The main supported browsers are Chrome and Safari. If Degraded is selected, the Component will only show if the browser does not support the experience. The main unsupported browser is Internet Explorer.

How to Configure Email Authentication

1. Click the Gray "Add Component" button, located in the top left corner under Content. 
2. Either scroll to the Email Authentication Component in the list or begin typing Email Authentication to search the list. 
3. Select the Email Authentication Component. The Email Authentication Component will appear at the bottom of the Content list in the left-hand column. The Email Authentication Properties will appear in the right-hand column.  

1. Name the Security Group.
2. Enter an allowed email or email domain. To authorize all emails within an organization enter an asterisk before the email domain. For example, to authorize all Lumavate email addresses, enter: *@lumavate.com

1. Click the Pencil Icon next to a Page. 
2. Under Page Properties, expand the Security Section. 
3. Select All logged in users or Specified user group(s) to require app users to login before viewing the content on that Page. The Login Page for the experience should be set to <None> as this will allow all experience users to access the Login Page.