Skip to main content
Skip table of contents

OTP Management Widget

Definition

The OTP Management widget is used to manage the available addresses enrolled using the OTP enrollment widget or through the Groovy API.

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 list of available addresses which can be enabled/disabled or deleted.

Configuration

Properties

When the widget is placed in a non-self feature it can manage the OTP addresses of any users in the scope of the feature. These features should hence be reserved for admin purposes.

Property name

Type

Mandatory

Description

Values (default value in bold)

canDelete

Boolean

NO

The user is allowed to delete addresses

true, false

canEnable

Boolean

NO

The user is allowed to enable/disable the address

true, false

otpModules

List<OTPModule>

NO

A list of OTP modules which configures the different CGW modules on which the addresses can be listed.

Empty List

obfuscate

Boolean

NO

Turn on/off obfuscation of addresses

true, false

otpModules properties

Property name

Type

Mandatory

Description

Values (default value in bold)

module

OTPModule

NO

The user is allowed to delete addresses

true, false

module properties

Property name

Type

Mandatory

Description

Values (default value in bold)

moduleId

String

NO

The OTP module id.

otpType

Enum

NO

The type of the OTP address.

EMAIL, PHONE

readOnly

Boolean

NO

In readOnly, the addresses of the module cannot be deleted or enabled/disabled

true, false

Example

XML
<widget id="otp-management-widget" xsi:type="ctdbum:OTPAddressManagementWidgetType">
	 <hidden>false</hidden>
	 <displayOptions>
		<modalSize>SM</modalSize>
	 </displayOptions>
	 <config>
		<bordered>false</bordered>
		<title>true</title>
		<canDelete>true</canDelete>
		<canEnable>true</canEnable>
		<otpModules>
		   <module>
			  <moduleId>corporate_mail</moduleId>
			  <otpType>EMAIL</otpType>
			  <readOnly>false</readOnly>
		   </module>
		</otpModules>
	 </config>
</widget>

Read Next

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.