Sms (Section)#
Path: /profiles/profile/settings/authentication-service/authenticators/authenticator/sms
An SMS authenticator. Sends a challange over SMS
Parameters#
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| send-otp-as-code | boolean | optional | false | The OTP in the SMS will be a regular OTP and not a hyperlink |
| otp-length | uint16 | optional | 6 | The length of the OTP |
| otp-or-hyperlink-time-to-live | uint32 | optional | 60 | The time the OTP or the hyperlink is valid |
| allow-registration-during-login | boolean | optional | true | Whether or not users should be able to add a new device during the login process |
| show-info-before-registration | boolean | optional | true | Whether or not the information page should be shown before the registration page |
| max-allowed-attempts | uint16 | optional | 3 | The 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-sent | uint16 | optional | 3 | The 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-enabled | boolean | optional | false | When active a login will be automatically performed after a successful registration |
| store-phone-number-as-verified | boolean | optional | - | If set to true, the authenticator will mark the phone number used during authentication as verified after a successful SMS authentication. |
Subsections#
| Name | Type | Description |
|---|---|---|
| account-manager-or-intermediate-attribute | OneOf | |
| prevent-account-enumeration | Section |