.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:

app_settings.json .token_login

propertytyperequireddescription
enabledBooleanyesEnables 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_keyStringyesTranslation 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:

"token_login": {
  "enabled": true,
  "translation_key": "sms.token.login.help"
}

CHT Applications > Reference > API : Login by Sms

RESTful Application Programming Interfaces for integrating with CHT applications