Methods
| Method | Returns | Description |
|---|---|---|
| getBackupPINs() | String | Get backup PINs for a user. |
| isInitialized() | Boolean | Check if two-factor authentication is initialized for a user. |
| reset() | void | Reset TFA for a user, requiring them to set it up again on next login. |
Method Details
getBackupPINs(loginUserName) → {String|null}
- Description:
Get backup PINs for a user. These can be used if the user loses access to their authenticator.
Parameters:
| Name | Type | Description |
|---|---|---|
loginUserName |
String | Username to get backup PINs for. |
Returns:
Backup PINs or null if not set.
- Type
- String | null
isInitialized(loginUserName) → {Boolean}
- Description:
Check if two-factor authentication is initialized for a user.
Parameters:
| Name | Type | Description |
|---|---|---|
loginUserName |
String | Username to check. |
Returns:
True if TFA is initialized.
- Type
- Boolean
reset(loginUserName)
- Description:
Reset TFA for a user, requiring them to set it up again on next login.
Parameters:
| Name | Type | Description |
|---|---|---|
loginUserName |
String | Username to reset TFA for. |