Building > Reference > API : Login by Sms
RESTful Application Programming Interfaces for integrating with CHT applications
Login via SMS settings are defined under the token_login
key, as an object supporting the following properties:
app_settings.json .token_login
property | type | required | description |
---|---|---|---|
enabled | Boolean | yes | Enables or disables token_login deployment-wide. When this is false, users can’t be updated to use token_login and any requests to login with a token link will fail. |
translation_key | String | yes | Translation key for the information (helper) sms message that the user receives, along with their token-login link |
The definition takes the typical form below:
"token_login": {
"enabled": true,
"translation_key": "sms.token.login.help"
}
RESTful Application Programming Interfaces for integrating with CHT applications
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.