Skip to main content

OTPAuthenticatorSettings

New OTP authenticator settings.

Properties

NameTypeDescriptionNotes
defaultDeliveryEnabledBooleanIndicates whether client applications can delivery OTP to default delivery contact or can enforce users to choose an OTP delivery.[optional]
deliveryMethodsList<OTPDeliveryMethod>The allowed OTP delivery mechanisms in order of preference. Default is SMS, followed by Email, and Voice.[optional]
includeOtpExpiryDateBooleanIndicates whether the OTP expiry date will be included in the OTP SMS message[optional]
otpAlphabetStringCharacters that can appear in a RANDOM OTP. Can contain any non-whitespace character. Default is all digits.[optional]
otpDefaultDeliveryOtpDefaultDeliveryEnumThe default OTP delivery mechanism. This attribute is deprecated, use the deliveryMethods attribute.[optional]
otpDefaultDeliveryAttributeStringId of the default OTP delivery attribute. Deprecated : Use default attribute specific to delivery mechanism instead eg. otpSmsDefaultDeliveryAttribute, otpEmailDefaultDeliveryAttribute[optional]
otpEmailDefaultDeliveryAttributeStringId of the default Email OTP delivery attribute.[optional]
otpLengthIntegerThe length of an OTP. Default is 8.[optional]
otpLifetimeIntegerThe lifetime of an OTP in seconds. Default is 300.[optional]
otpSmsDefaultDeliveryAttributeStringId of the default SMS OTP delivery attribute.[optional]
otpTypeOtpTypeEnumThe type of OTP generated. Choices are RANDOM or MEMO_PASSCODE. Default is RANDOM[optional]
otpVoiceDefaultDeliveryAttributeStringId of the default Voice OTP delivery attribute.[optional]
showOtpDeliveryContactBooleanIndicates whether masked OTP contact attribute values are included in authentication API.[optional]

OtpDefaultDeliveryEnum

NameValue
EMAIL"EMAIL"
SMS"SMS"
VOICE"VOICE"
NONE"NONE"

OtpTypeEnum

NameValue
RANDOM"RANDOM"
MEMO_PASSCODE"MEMO_PASSCODE"