POST /_system/security/methods/sms

Create SMS-based 2FA authentication method

Create SMS-based 2FA authentication method
KeyTypeExampleDescription
authorizationrequiredstring
"Bearer access_token"
Access token
KeyTypeExampleDescription
nameoptionalstring
"My Phone"
phone_numberrequiredstring
"+1234567890"
{
  "sms_send": true
}
{
  "error": "ERROR_KEY"
}
PermissionDescription
Bearer tokenAccess token required via Authorization header, x-authtoken, x-token, query param, or cookie
users_twofactorauth_createRequired scope: users_twofactorauth_create

Back to System Security Return to the System Security category to view other endpoints All API Categories Browse all available API categories