MFA Device Enrollment Widget

Definition

This widget displays a set of buttons that allows to:

enroll a new Device immediately
send a device Enrollment Link by email

Configuration

Properties

Properties name	Type	Mandatory	Description	Values (default value in bold)
design	`myMFADesign`	NO	Options to display the myMfa iframe.	-
allowImmediateEnrollment	`Boolean`	NO	Indicates whether or not devices can be immediately enrolled.	true, false
allowDisplayActivationCode	`Boolean`	NO	Allows to display Activation Code. Often uses in cases of M_ACCESS browserEnrollmentMethod	true, false
immediateEnrollmentOptions	`MyMFADeviceEnrollmentOptions`	NO	Options for immediate enrollment.
allowEnrollmentLink	`Boolean`	NO	Indicates whether or not devices can be enrolled with an enrollment link.	true, false
enrollmentLinkOptions	`MyMFADeviceEnrollmentLinkOptions`	NO	Options for enrollment through a link.	-

Design properties

Properties name	Type	Mandatory	Description	Values (default value in bold)
bgColor	`String`	NO	Indicates the color of the Popup container background (CSS like hex, "red" rgb() etc.)	#999999
borderColor	`String`	NO	Indicates the color of the Popup external border (CSS like hex, "red" rgb() etc.)	#2D5F8B
displayStyle	`Enum`	NO	Indicates the type of display of the enrollment.	INLINE, MODAL
left	`String`	NO	Indicates the distance in % from the container left.	0
mainColor	`String`	NO	Indicates the popup main color.	#2D5F8B
rounded	`Boolean`	NO	Indicates if corners are rounded.	false, true
shaded	`Boolean`	NO	Indicates if the box is shaded.	false, true
skin	`String`	NO	Indicates the theme used for the window insides.	default, mobile
titleColor	`String`	NO	Indicates the color of the title.	#FFFFFF
titlebgColor	`String`	NO	Indicates the color of the title bar background.	#2D5F8B
top	`String`	NO	Indicates the distance in % from the container top.	0
withActionTitle	`Boolean`	NO	Indicates if the title inside the popup will be shown. This title is closely related to the action currently processed in the popup (authentication, activation…)	false, true
withBorder	`Boolean`	NO	Indicates if the popup external border is removed, along with the background color of the container.	false, true
withLogo	`Boolean`	NO	Indicates if the myMFA logo is displayed.	false, true
withTitle	`Boolean`	NO	Indicates if the title inside the popup will be shown.	false, true

immediateEnrollmentOptions properties

Properties name	Type	Mandatory	Description	Values (default value in bold)
deviceTypes	-	NO	Device type	-
browserEnrollmentMethod	`Enum`	NO	The method used to enroll a browser.	EMBEDDED, MY

deviceTypes properties

Properties name	Type	Mandatory	Description	Values (default value in bold)
deviceType	`Enum`	NO	Two types of devices are available to be enrolled immediately.	BROWSER, MOBILE

enrollmentLinkOptions properties

Properties name	Type	Mandatory	Description	Values (default value in bold)
mode	`Enum`	NO	Two modes of device enrollment are available through a link.	UNIQUE, DEVICE
deviceEnrollmentLinkIntent	`String`	NO	Identifier of the Self-Service feature to enroll a device. By default this will provide the choice between mobile and browser. Used when mode is UNIQUE.	my_mfa_enroll
deviceEnrollmentLinkIntentBrowser	`String`	NO	Identifier of the Self-Service feature to enroll a Browser device. Used when mode is DEVICE and BROWSER is selected.	my_mfa_enroll_browser
deviceEnrollmentLinkIntentMobile	`String`	NO	Identifier of the Self-Service feature to enroll a Mobile device. Used when mode is DEVICE and MOBILE is selected.	my_mfa_enroll_mobile
deviceEnrollmentLinkUseCount	`Int`	NO	Number of times the enrolment link can be accessed (during the validity period).	1
displayDeviceEnrollmentLink	`Boolean`	NO	Indicates whether or not the enrollment link shall be displayed on screen.	true, false
sendDeviceEnrollmentLink	`Boolean`	NO	Indicates whether or not the enrollment link shall be sent by notification.	true, false
sendDeviceEnrollmentLinkEmailOverride	`Boolean`	NO	Authorizes to override the destination email address when sending the device enroll link by email.	true, false
actions	`Actions`	NO	Allows to define actions (notification sending, script execution...) that will be performed when the feature is submitted. In the case of a rule exection, it must be of MYMFA category.	-

Example

XML

<widget id="my-mfa-device-enrollment-widget" xsi:type="ctdbum:MyMFADeviceEnrollmentWidgetType">
	<hidden>false</hidden>
    <config>
        <bordered>false</bordered>
        <title>true</title>
        <mobileAppType>MEMORITY_APP</mobileAppType>
        <design>
            <bgColor>#999999</bgColor>
            <borderColor>#2D5F8B</borderColor>
            <displayStyle>INLINE</displayStyle>
            <left>0</left>
            <mainColor>#2D5F8B</mainColor>
            <rounded>false</rounded>
            <shaded>false</shaded>
            <skin>default</skin>
            <titleColor>#FFFFFF</titleColor>
            <titlebgColor>#2D5F8B</titlebgColor>
            <top>0</top>
            <withActionTitle>true</withActionTitle>
            <withBorder>false</withBorder>
            <withLogo>false</withLogo>
            <withTitle>false</withTitle>
		</design>
        <allowImmediateEnrollment>false</allowImmediateEnrollment>
        <allowDisplayActivationCode>false</allowDisplayActivationCode>
        <immediateEnrollmentOptions>
          <deviceTypes>
            <deviceType>BROWSER</deviceType>
            <deviceType>MOBILE</deviceType>
          </deviceTypes>
          <browserEnrollmentMethod>EMBEDDED</browserEnrollmentMethod>
        </immediateEnrollmentOptions>
        <allowEnrollmentLink>true</allowEnrollmentLink>
        <enrollmentLinkOptions>
          <mode>UNIQUE</mode>
          <deviceTypes />
          <deviceEnrollmentLinkIntent>identity-common-public-myMFAEnroll</deviceEnrollmentLinkIntent>
          <deviceEnrollmentLinkIntentBrowser>myMFA-enroll-browser</deviceEnrollmentLinkIntentBrowser>
          <deviceEnrollmentLinkIntentMobile>myMFA-enroll-mobile</deviceEnrollmentLinkIntentMobile>
          <deviceEnrollmentLinkUseCount>1</deviceEnrollmentLinkUseCount>
          <displayDeviceEnrollmentLink>false</displayDeviceEnrollmentLink>
          <sendDeviceEnrollmentLink>true</sendDeviceEnrollmentLink>
          <sendDeviceEnrollmentLinkEmailOverride>false</sendDeviceEnrollmentLinkEmailOverride>
          <actions>
            <action class="actionNotification">
              <config xsi:type="ctdrule:CitadelNotificationConfigurationType">
                <notifications>AIW1-common-enrollment-emailDefinition</notifications>
              </config>
            </action>
          </actions>
        </enrollmentLinkOptions>
	</config>
</widget>

Configuration

Properties

Design properties

immediateEnrollmentOptions properties

deviceTypes properties

enrollmentLinkOptions properties

Example

Read Next