Overview
Error Handling

Methods

API Documentation (API Version bleed)

Account/Auth/TwoFactor/

DESCRIPTION

This section contains methods for setting up, enabling, and disabling two-factor authentication (TFA).

activation_key

URL:

https://api.liquidweb.com/bleed/Account/Auth/TwoFactor/activation_key

Description:

If two-factor authentication (TFA) is not already enabled: Creates a new TFA activation key, applies it to the user, and returns it.

If TFA is already enabled: An exception will be thrown. To generate a fresh key, disable TFA and then call this method.

Parameters:

ParameterType
usernameA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).

Returns:

FieldType
keyA sixteen character string.

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

disable

URL:

https://api.liquidweb.com/bleed/Account/Auth/TwoFactor/disable

Description:

Parameters:

ParameterTypeNotes
passcodeA six digit TFA passcode* Required
usernameA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).

Returns:

FieldType
disabledA boolean value (0 or 1).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types

enable

URL:

https://api.liquidweb.com/bleed/Account/Auth/TwoFactor/enable

Description:

Parameters:

ParameterTypeNotes
passcodeA six digit TFA passcode* Required
usernameA subaccnt username consisting of up to 63 characters (letters, numbers, hyphens, underscores, periods, pluses, or at symbols).

Returns:

FieldType
enabledA boolean value (0 or 1).

Possible Errors:

Refer to the Error Handling documentation for the list of exception types