Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: added docs for 2fa for users #51

Merged
merged 1 commit into from
Jun 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 48 additions & 8 deletions docs/dashboard/manage-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,58 @@ sidebar_position: 14

In **Manage Users** section, you can manage all the users of your organization.

![Manage Users](/assets/1.x.x/manage-users.png)
![Manage Users](/assets/2.0.x/manage-users.png)

### ➕ Create User
**Create** a new user by clicking on `Create User` button.
:::note

Currently, you can only create a user with `admin` role, so new user will have all the permissions.
We will be adding more roles for granular permission control soon.

:::


**You can -**
1. **Create** a new user by clicking on `Create User` button.
> ⚠️ **Note :** Currently, you can only create a user with `admin` role, so new user will have all the permissions.
> We will be adding more roles for granular permission control soon.

After clicking on `Create User` button, you will see a form like this:

![Create User](/assets/1.x.x/create-user.png)

Enter the required details and click on `Create` button. The user will be created.

2. **Delete** a user by clicking on `Delete` button.
> **Note :** You can't delete current logged in user.
### ⛔ Delete User
**Delete** a user by clicking on `Delete` button.

:::note

tanmoysrt marked this conversation as resolved.
Show resolved Hide resolved
You can't delete current logged in user.

:::

tanmoysrt marked this conversation as resolved.
Show resolved Hide resolved
### 🔐 Enable Two Factor Authentication [2FA]

1. Click on `Manage Users` from the `Administration` section's sidebar.

![Manage Users](/assets/2.0.x/manage-users-2fa-enable.png)

2. Click on `Enable TOTP` button.

![Enable TOTP](/assets/2.0.x/enable-2fa-modal.png)

You can use `Google Authenticator`, `Authy`, `Microsoft Authenticator` , `Bitwarden` , `Ente Auth` or any other 2FA app to register the 2FA request and generate the QR code.

3. After adding the record in 2FA App, take the TOTP from app and submit it in the form to enable 2FA.
tanmoysrt marked this conversation as resolved.
Show resolved Hide resolved
4. Logout and try to login again.
5. After providing the `username` and `password`, you will see an extra input field for `TOTP`.

![Enable TOTP](/assets/2.0.x/log-in-with-totp-enabled.png)

6. Congratulations 🥳! You have enabled 2FA for your account.

tanmoysrt marked this conversation as resolved.
Show resolved Hide resolved
### 🔒 Disable Two Factor Authentication [2FA]

1. Click on `Manage Users` from the `Administration` section's sidebar.

![Manage Users](/assets/2.0.x/manage-users-2fa-disable.png)

2. Click on `Disable TOTP` button.
3. That's it! You have disabled 2FA for your account.
Binary file added static/assets/2.0.x/enable-2fa-modal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/assets/2.0.x/log-in-with-totp-enabled.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/assets/2.0.x/log-in.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/assets/2.0.x/manage-users-2fa-disable.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/assets/2.0.x/manage-users-2fa-enable.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/assets/2.0.x/manage-users.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
56 changes: 48 additions & 8 deletions versioned_docs/version-2.0.x/dashboard/manage-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,58 @@ sidebar_position: 14

In **Manage Users** section, you can manage all the users of your organization.

![Manage Users](/assets/1.x.x/manage-users.png)
![Manage Users](/assets/2.0.x/manage-users.png)

### ➕ Create User
**Create** a new user by clicking on `Create User` button.
:::note

Currently, you can only create a user with `admin` role, so new user will have all the permissions.
We will be adding more roles for granular permission control soon.

:::


**You can -**
1. **Create** a new user by clicking on `Create User` button.
> ⚠️ **Note :** Currently, you can only create a user with `admin` role, so new user will have all the permissions.
> We will be adding more roles for granular permission control soon.

After clicking on `Create User` button, you will see a form like this:

![Create User](/assets/1.x.x/create-user.png)

Enter the required details and click on `Create` button. The user will be created.

2. **Delete** a user by clicking on `Delete` button.
> **Note :** You can't delete current logged in user.
### ⛔ Delete User
**Delete** a user by clicking on `Delete` button.

:::note

tanmoysrt marked this conversation as resolved.
Show resolved Hide resolved
You can't delete current logged in user.

:::

tanmoysrt marked this conversation as resolved.
Show resolved Hide resolved
### 🔐 Enable Two Factor Authentication [2FA]

1. Click on `Manage Users` from the `Administration` section's sidebar.

![Manage Users](/assets/2.0.x/manage-users-2fa-enable.png)

2. Click on `Enable TOTP` button.

![Enable TOTP](/assets/2.0.x/enable-2fa-modal.png)

You can use `Google Authenticator`, `Authy`, `Microsoft Authenticator` , `Bitwarden` , `Ente Auth` or any other 2FA app to register the 2FA request and generate the QR code.

3. After adding the record in 2FA App, take the TOTP from app and submit it in the form to enable 2FA.
tanmoysrt marked this conversation as resolved.
Show resolved Hide resolved
4. Logout and try to login again.
5. After providing the `username` and `password`, you will see an extra input field for `TOTP`.

![Enable TOTP](/assets/2.0.x/log-in-with-totp-enabled.png)

6. Congratulations 🥳! You have enabled 2FA for your account.

tanmoysrt marked this conversation as resolved.
Show resolved Hide resolved
### 🔒 Disable Two Factor Authentication [2FA]

1. Click on `Manage Users` from the `Administration` section's sidebar.

![Manage Users](/assets/2.0.x/manage-users-2fa-disable.png)

2. Click on `Disable TOTP` button.
3. That's it! You have disabled 2FA for your account.
Loading