POST /_system/security/methods/sms
Create SMS-based 2FA authentication method
Create SMS-based 2FA authentication method
| Key | Type | Example | |
|---|---|---|---|
| authorization required | string |
"Bearer your-jwt-token"
|
| Key | Type | Example | Description |
|---|---|---|---|
| phone_number required | string |
"+1234567890"
|
|
| name optional | string |
"My Phone"
|
{
"_meta": {
"guid": "example-string",
"entity": "example-value",
"created": "example-value",
"modified": "example-value",
"updated": "example-value"
},
"type": "totp",
"name": "example-string",
"is_default": true,
"verified": true
}
{
"success": false,
"error": "ERROR_KEY"
}
| permission | description |
|---|---|
BearerAuth |
JWT access token obtained from login endpoint required |
Back to System Security Return to the System Security category to view other endpoints All API Categories Browse all available API categories