Skip to main content

OTPAuthenticatorSettings

New OTP authenticator settings.

Properties

NameTypeDescriptionNotes
default_delivery_enabledboolIndicates whether client applications can delivery OTP to default delivery contact or can enforce users to choose an OTP delivery.[optional]
delivery_methodsList[OTPDeliveryMethod]The allowed OTP delivery mechanisms in order of preference. Default is SMS, followed by Email, and Voice.[optional]
include_otp_expiry_dateboolIndicates whether the OTP expiry date will be included in the OTP SMS message[optional]
otp_alphabetstrCharacters that can appear in a RANDOM OTP. Can contain any non-whitespace character. Default is all digits.[optional]
otp_default_deliverystrThe default OTP delivery mechanism. This attribute is deprecated, use the deliveryMethods attribute.[optional]
otp_default_delivery_attributestrId of the default OTP delivery attribute. Deprecated : Use default attribute specific to delivery mechanism instead eg. otpSmsDefaultDeliveryAttribute, otpEmailDefaultDeliveryAttribute[optional]
otp_email_default_delivery_attributestrId of the default Email OTP delivery attribute.[optional]
otp_lengthintThe length of an OTP. Default is 8.[optional]
otp_lifetimeintThe lifetime of an OTP in seconds. Default is 300.[optional]
otp_sms_default_delivery_attributestrId of the default SMS OTP delivery attribute.[optional]
otp_typestrThe type of OTP generated. Choices are RANDOM or MEMO_PASSCODE. Default is RANDOM[optional]
otp_voice_default_delivery_attributestrId of the default Voice OTP delivery attribute.[optional]
show_otp_delivery_contactboolIndicates whether masked OTP contact attribute values are included in authentication API.[optional]

Example