Skip to content

Commit 29f79c9

Browse files
Merge pull request #5673 from Countly/2FA-readme.md
create README.md for 2FA
2 parents 750d5b0 + 85d6033 commit 29f79c9

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

plugins/two-factor-auth/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Two Factor Authentication
2+
3+
The Two-Factor Authentication (2FA) Plugin for Countly enhances account security by adding an additional layer of authentication. It allows users to enable or disable 2FA for their accounts and provides administrative controls for managing 2FA settings for other users.
4+
5+
## Configuration View:
6+
7+
Registers labels for 2FA settings to customize the web UI.
8+
9+
## TwoFAUser Component:
10+
11+
Manages the 2FA setup modal.
12+
Initializes 2FA settings and handles user interactions for enabling or disabling 2FA.
13+
Sends requests to enable or disable 2FA and handles success and error responses.
14+
15+
## Registering the Component:
16+
17+
Registers the TwoFAUser component in the Countly Vue container under the account settings page.
18+
This plugin provides a comprehensive solution for managing 2FA settings within the Countly application, enhancing the security of user accounts by requiring an additional authentication step.

0 commit comments

Comments
 (0)