Two_Factor

The config command does not require entering properties or arguments. Enter the command, then press Enter. The command returns a table with the current two-factor settings.

From the CLI prompt, enter:

auth two_factor config

auth two_factor config
+------------+--------+
|         id | 1      |
| otp_digits | 6      |
|     secret | <null> |
|     window | 0      |
|   interval | 30     |
|   services | <dict> |
|    enabled | false  |
+------------+--------+

The update enabled command requires you to include either the true (enable) or false (disable) option. Enter the command string, then press Enter. The command returns nothing when successful.

From the CLI prompt, enter:

auth two_factor update enable=true/false

Where true* enables two-factor authentication, and false disables it.

auth two_factor update enabled=true

The update otp_digits command requires you to include a number from six to eight. Enter the command string, then press Enter. The command returns nothing when successful, and returns an error when you enter an invalid integer.

From the CLI prompt, enter:

auth two_factor update otp_digits=number

Where number is the number of digits from six to eight.

auth two_factor update otp_digits=6

The update window command extends the validity of one-time passwords and requires you to include an integer. Enter the command string, then press Enter. The command returns nothing when successful, and returns an error when you enter an invalid integer.

From the CLI prompt, enter:

auth two_factor update window=number

Where number is the number of passwords before and after the current one that are still valid. Must be between 0 and 999999999999999999.

auth two_factor update window=1

The update interval command sets the lifespans of one-time passwords and requires you to include an integer. Enter the command string, then press Enter. The command returns nothing when successful, and returns an error when you enter an invalid integer.

From the CLI prompt, enter:

auth two_factor update interval=number

Where number is the number (in seconds) an OTP will last before expiring. Must be between 5 and 999999999999999999.

auth two_factor update interval=30

The update services command enables or disables 2FA for SSH logins, and requires you to include an argument. Enter the command string, then press Enter. The command returns nothing when successful.

From the CLI prompt, enter:

auth two_factor update services={“ssh”:true/false

Where true/false enables (true) or disables (false) SSH 2FA authentication.

auth two_factor update services={"ssh":true}