Sms (Section)#

Path: /profiles/profile/settings/authentication-service/authenticators/authenticator/sms

An SMS authenticator. Sends a challange over SMS

Parameters#

NameTypeRequiredDefaultDescription
send-otp-as-codebooleanoptionalfalseThe OTP in the SMS will be a regular OTP and not a hyperlink
otp-lengthuint16optional6The length of the OTP
otp-or-hyperlink-time-to-liveuint32optional60The time the OTP or the hyperlink is valid
allow-registration-during-loginbooleanoptionaltrueWhether or not users should be able to add a new device during the login process
show-info-before-registrationbooleanoptionaltrueWhether or not the information page should be shown before the registration page
max-allowed-attemptsuint16optional3The maximum number times a user is allowed to try to validate a OTP. When this value is set to 0, there is no maximum attempts enforced.
max-challenges-sentuint16optional3The maximum number of OTP or hyperlinks that is allowed to be sent during one session. When this value is set to 0, there is no maximum attempts enforced.
auto-login-enabledbooleanoptionalfalseWhen active a login will be automatically performed after a successful registration
store-phone-number-as-verifiedbooleanoptional-If set to true, the authenticator will mark the phone number used during authentication as verified after a successful SMS authentication.

Subsections#

Was this helpful?