Build > Reference > API : Login by Sms
RESTful Application Programming Interfaces for integrating with CHT applications
.token_login
**Token login**: Instructions and schema for Login by SMS
Login via SMS settings are defined under the token_login key, as an object supporting the following properties:
As of CHT
5.0.0, the app_url config is required when enabling token login. If token_login.enabled is true and app_url is not set, token login will not work and errors will be thrown.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 |
Code sample
The definition takes the typical form below:
"app_url": "https://example.org",
"token_login": {
"enabled": true,
"translation_key": "sms.token.login.help"
}Related Content
Last updated on
Did this documentation help you ?