CPcpanel
TwoFactorAuth
Two-Factor Settings

Return team user 2FA config

This function retrieves a team user's configuration settings for two-factor authentication.

get/TwoFactorAuth/get_team_user_configuration

Request

  • Base URL
    https://cpanel-server.tld:2083/execute
  • Auth
    HTTP basic

Query parameters

team_userstring required
Example:user@example.com

The team user's username.

Note:

The username will always precede the cPanel account's primary domain.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "get_team_user_configuration",
  "module": "TwoFactorAuth",
  "result": {
    "data": {
      "is_enabled": 1,
      "issuer": "Example WebPros International, LLC"
    },
    "status": 1
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.