API: Enable TOTP MFA

setupClientTOTPMFA

Enable Time-Based One-Time Password MFA for a specific client. Available only if Google Authenticator module is active/used

Required parameters

Parameter	Description
client_id	Client Id

Optional parameters

Parameter	Description
mfa_secret	The code/secret with which the mfa will be added

Request

GET /admin/api.php?api_id=API_ID&api_key=API_KEY&call=setupClientTOTPMFA&client_id=CLIENT_ID

PHP Samples

PHP Samples: Setup Google Authenticator TOTP MFA for client with ID 1 with random secret

PHP Samples: Setup Google Authenticator TOTP MFA for client with ID 1 with specific secret

Response

{
    "success": true,
    "mfa_secret": "G7UXXPahhFipZay2",
    "call": "setupClientTOTPMFA",
    "server_time": 1738142487
}