Magic Enrollment

From iDENprotect Knowledge Base
Jump to: navigation, search


Introduction

Magic Enrollment is a new feature present in 3.12+ versions of the Core Platform. Magic Enrollment is where an idenprotect For Mobile client can enrol to the Core Platform without a QR Code. In order for this to be fully functional, you must also ensure that you are running 3.12 or above version of the User Portal. The idenprotect For Mobile clients are required to be on versions above 3.11. The latest apps can be found on their respective app stores.

By default, when receiving an enrollment email from the Core Platform it should look like the following:

New Enrollment Email (Dark Mode)
New Enrollment Email (Light Mode)

Set Up

The setup process for Magic Enrollment is fairly simple and should not take any longer than 10 minutes.

Note: if you are conducting a fresh install of version 3.12 then there is no additional set up required to enable Magic Enrollment.


Setting up Magic Enrollment on upgrade

When upgrading the server, you may already have an email template in place that is sent out to your users. To enable magic enrollment please add the following lines of code to your email template:

Magic Enrollment Code Block

The colours can be customised but it is important to keep the '$qrUrl' as this link by default Is used to point towards the User Portal.

Note: Email templates can be found under config -> Email -> User Enrollment

Testing Magic Enrollment

To test please do the following:

1) Send an enrollment email to a user.
2) Open the enrollment email on a mobile device and click on the link.
3) This should redirect you to the browser where the enrollment page will be shown (a QR code may be shown briefly for a few seconds whilst the redirect occurs). On a desktop, this page will show a QR code.

    * iOS users: If the app is already installed you will be automatically redirected to the app.
    * Android users: A button will appear requesting to begin enrollment.

4) Once you have been redirected, press the begin enrollment button on the app and the enrollment should begin.
5) If the device has successfully enrolled, you can verify that Magic Enrollment is working as expected.

Magic Enrollment End User Guide

Steps 2 - 5 are applicable for an end-user who wishes to enrol their device without a QR code.

Disabling Magic Enrollment

To disable magic enrollment please remove the link from the email template. However, please note that by doing so, users will not receive the link to Easy Enrollment as the link is the same. We, therefore, suggest that Magic Enrollment is not disabled. In addition, Magic Enrollment only works if users already have access to their company emails on their device. If this is not the case, standard QR Code Enrollment is required.

Troubleshooting

There are scenarios in which Magic Enrollment may not work as expected. Most common scenarios are listed below:

Error Possible Cause Possible Solution
Android application is not opening when pressing the button in the browser An outdated version is being used. Please ensure that you are using the latest version of the android app.
Android application is opening but I am still asked to scan a QR code This occurs when either the enrollment session has expired or no information could be retrieved about the enrollment session. Please check the logs on the Core Platform to see if any errors are reported. Network issues may also be a culprit.
iOS application is not being redirected. An outdated application is being used Please ensure you are using an iOS client version above 3.11
iOS application is not being redirected. There is a known issue with Safari not always completing the request to open the app. Please try another browser such as Chrome or Edge if your company policies allow you to do so. If this is not possible, please copy the link in the browser address bar and open a new safari tab. Paste the copied link and the redirect should now occur as expected.
iOS application opens up QR Scanner after pressing Begin Enrollment This occurs when either the enrollment session has expired or no information could be retrieved about the enrollment session. Please check the logs on the Core Platform to see if any errors are reported. Network issues may also be a culprit.