Merge pull request #2914 from topherMarie/enrollments

Enrollments

Author: mpaktiti

articles/multifactor-authentication/administrator/customizing-widget.md

@@ -9,3 +9,43 @@ You may change the logo and the friendly name that is displayed to your users. T
 
  * **Friendly Name**: the name of the app that you want displayed to users
  * **Logo URL**: the URL that points to the logo image you want displayed to users
+
+## Customizing the Guardian Landing Page
+
+### Activate the Hosted Page
+
+Customizing the content of the Guardian widget page is possible in the [Guardian Multifactor Hosted Page](${manage_url}/#/guardian_mfa_page) by toggling _Customize Guardian Page_. 
+
+![](/media/articles/mfa/guardian-mfa-hosted-page.png)
+
+### Theming Options
+There are a few theming options for _mfa-widget_, namespaced under the `theme` property.
+
+#### icon 
+The value for `icon` is the URL for an image that will be used in the _mfa-widget_ header, which defaults to the Auth0 logo. It has a recommended max height of `58px` for a better user experience.
+
+```js
+      theme: {
+        icon: 'https://example.com/assets/logo.png'
+      },
+```
+
+#### primaryColor
+The `primaryColor` property defines the primary color of the _mfa-widget_. This option is useful when providing a custom `icon`, to ensure all colors go well together with the `icon`'s color palette. Defaults to `#ea5323`.
+
+```js
+      theme: {
+        icon: 'https://example.com/assets/logo.png',
+        primaryColor: 'blue'
+      },
+```
+
+### Rendering "Invited Enrollments" vs. Standard Scenarios
+There are two different possible scenarios in which the page is rendered. If a user has been directed to this page specifically for enrollment (for instance, from an email with an enrollment link) then the property **ticket** will be available. Otherwise, the property **requestToken** will be available.
+
+### HTML + Liquid syntax
+
+The hosted page uses [Liquid](https://github.com/Shopify/liquid/wiki/Liquid-for-Designers) syntax for templating. 
+The following parameters are available to assist in rendering your page: **userData.email**, **userData.friendlyUserId**, **userData.tenant**, **userData.tenantFriendlyName**, **iconUrl**.
+Most of the parameters that are used in MFA-Widget need to be passed to Guardian as shown in the default template provided in the customization area.
+If you need a higher level of customization you could use [auth0-guardian.js](https://github.com/auth0/auth0-guardian.js/tree/master/example).

articles/multifactor-authentication/administrator/guardian-enrollment-email.md

@@ -0,0 +1,36 @@
+---
+description: Send an enrollment email (Guardian)
+---
+## Sending a Guardian Enrollment Email to a User.
+
+With this, an administrator can send an email to a user with a link for registering their device with Guardian.
+
+To send this email:
+
+1. Find and select the user in the [Users](${manage_url}/#/users) section of the dashboard.
+2. Click on the **Actions** button on the top right of the screen. 
+3. Select **Send Enrollment Email (Guardian)** from the dropdown.
+
+ ![](/media/articles/mfa/guardian-send-enrollment-email.png)
+
+The user will receive an enrollment email at their registered email address.
+
+Administrators can also [customize the email template](/email/templates) for the enrollment emails.
+
+## Restricting user-initiated enrollments
+
+Some organizations may want to only allow users to enroll a device with Guardian via an enrollment email, and prevent users from self-enrolling upon first sign in. This is possible using the _selfServiceEnrollment_ property on a Guardian rule. When set to true, or when the property is not set, the user may self-enroll. When set to false, the user may only enroll their device via an enrollment email.
+
+To edit the rule, go to the **Multifactor Auth** section and edit appropriately.
+
+```js
+function (user, context, callback) {
+
+  context.multifactor = {
+    provider: 'guardian', 
+    selfServiceEnrollment: false, 
+  };
+
+  callback(null, user, context);
+}
+```

articles/multifactor-authentication/administrator/index.md

@@ -16,6 +16,7 @@ This page contains information on how to enable and configure Guardian as an adm
 
 ## Managing Users
 * [Applying Guardian to Specific Users](/multifactor-authentication/administrator/guardian-for-select-users)
+* [Sending Guardian Enrollment Emails](/multifactor-authentication/administrator/guardian-enrollment-email)
 * [Resetting Guardian Credentials](/multifactor-authentication/administrator/reset-user)
 * [Guardian logs](/multifactor-authentication/administrator/guardian-logs)