Return team user 2FA config

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

SecurityBasicAuth

Request

query Parameters

team_user

required

string

The team user's username.

Note:

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

Example: team_user=user@example.com

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/TwoFactorAuth/get_team_user_configuration

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  TwoFactorAuth \
  get_team_user_configuration \
  team_user=teamuser

Response samples

application/json

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