.png)
OTP Enrollment Widget
Definition
The OTP enrollment widget is used to provision a verified “address” (email, phone) as a method to receive One-Time-Password (OTP) for authentication.
It is a standalone widget that requires a host feature of type "self" or an object feature where the object is the current subject.
Typically used in a UI_FOR_OBJECT feature of type "self".
The user is presented with a screen that invites him to enroll an address to receive "One Time Password".
The widget communicates with the Credential Gateway Service (CGW) and require the existence of OTP module configurations on this service.
Configuration
Properties
Property | Type | Mandatory | Description | Values (Default values in bold) |
|---|---|---|---|---|
otpType |
| YES | The type of the OTP address. This will change the input on the frontend to prompt for an email or a phone number. This type is also registered on the Credential Gateway Service. | EMAIL, PHONE |
otpModuleId |
| YES | The OTP module id which corresponds to an existing module configuration with the same “otpType” on the CGW service | - |
Example
<widget id="otp-enrollment-widget" xsi:type="ctdbum:OTPEnrollmentWidgetType">
<hidden>false</hidden>
<config>
<bordered>false</bordered>
<title>true</title>
<otpType>EMAIL</otpType>
<otpModuleId>corporate_mail</otpModuleId>
</config>
</widget>Authoritative enrollment
To provision addresses using a Groovy API , see Rule & Actions API API_OTP.