latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Authentication
Two-Factor Authentication

Return cPanel accounts with 2FA enabled

This function returns a list of user-controlled accounts and whether the accounts have Two-Factor Authentication (2FA) enabled.

get/twofactorauth_get_user_configs

Query parameters

userstring username
Example:example

The username for a specified account.

Note:

If you do not specify a value, the function returns all user accounts.

Response

HTTP Request was successful.

dataobject

The data that the function returns.

Example response

{
  "data": {
    "example": {
      "is_enabled": 0,
      "primary_domain": "example.com"
    }
  },
  "metadata": {
    "command": "twofactorauth_get_user_configs",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}