diff --git a/docs/docs/help/FAQs/_category_.json b/docs/docs/help/FAQs/_category_.json index 8141a5960..a95c7f9f8 100644 --- a/docs/docs/help/FAQs/_category_.json +++ b/docs/docs/help/FAQs/_category_.json @@ -1,6 +1,6 @@ { "label": "FAQs", - "position": 6, + "position": 7, "link": { "type": "generated-index", "description": "FAQs on Utilizing Various Features of OpenSign™ - The World's Leading Free & Open Source Document Signing Platform." diff --git a/docs/docs/help/Settings/manage-users.md b/docs/docs/help/Settings/manage-users.md index 157866691..914c4416f 100644 --- a/docs/docs/help/Settings/manage-users.md +++ b/docs/docs/help/Settings/manage-users.md @@ -62,6 +62,19 @@ To add a new user: - Use the toggle in the **Active** column to enable or disable a user’s account. - **Deactivated users** will not be able to log in to OpenSign until reactivated. +--- +## 🔁 Delete Users + +- OpenSign allows **admins** to delete users when needed. +- Once a user is deleted, their account and all associated data are **permanently removed**. OpenSign does **not** keep deleted user records and restoration is **not possible**. +- To delete a user: + 1. Click the **Delete** button next to the user you want to remove. + 2. A confirmation popup will appear. + 3. Enter the user’s email in the input box and click **Delete**. +- After deletion, the user (and all related data) will be permanently erased. + +> ⚡ **Note:** Once a user is deleted, your **available user count will automatically increase**. + --- ## 🔐 Permissions by Role diff --git a/docs/docs/help/User Menu/Profile.md b/docs/docs/help/User Menu/Profile.md new file mode 100644 index 000000000..70d1f541a --- /dev/null +++ b/docs/docs/help/User Menu/Profile.md @@ -0,0 +1,125 @@ +--- +sidebar_position: 1 +title: Profile +--- +import ReactPlayer from 'react-player'; + +# 👤 Profile + +The **Profile ** in OpenSign allows users to manage their personal and account-related details. You can update your information, verify your email, and set up a public profile. + +Profile Menu + +--- + +## 📌 Profile Information + +Profile Information + +### 🔐 Roles + +- **Admin** + - Role is displayed under your avatar. + - Has access to all features, including **User Management** and **Billing**. + +- **OrgAdmin** + - Has the same access as Admin. + - **Does not** have access to the **Console Application** or **Billing details**. + +- **Editor/User**: Cannot access Console Application, Billing, and are restricted from creating Teams, sharing templates. +--- + +### 👤 User Details + +- **Name** – Displays the full name of the user. +- **Phone** – Shows the registered phone number. +- **Email** – Displays the user’s registered email address. This cannot be changed or updated. It is used for login and notifications. +- **Company** – Shows the company name associated with the account. +- **Job Title** – Displays the job title of the user. + +--- + +## ✅ Email Verification + +- **Is Email Verified:** Indicates whether your email is verified. +- If **Not Verified**, click **Verify** to begin the verification process. + - An OTP will be sent to your registered email address. + - Enter the OTP to complete verification. This is a one-time process, and once verified, the status will update to Verified. + +--- + +## 🌍 Public Profile + +- **Public Profile Username** + Set a unique username to create your **public profile**. + +- **Share Templates Publicly** + Your public profile allows you to share templates openly, enabling signers to sign documents easily. + +- **Tagline** + Add a short tagline to your profile by entering text in the **Tagline** field. + This tagline will be displayed publicly as part of your profile information. + +--- + +### 🔖 Disable DocumentId + +Whenever a document is signed by all parties, **OpenSign™ automatically adds a unique DocumentId** at the top-left corner of the signed document. + +This ID can be used later to **verify the authenticity of the document**, so we **strongly recommend keeping it enabled**. + +If you prefer not to include the DocumentId in your signed documents, simply toggle the **Disable DocumentId** switch **ON**. + +> **Note:** This feature is available only for paid users. + +### Language + +Users can set their preferred language for this account. Once a language is selected, it will be applied whenever the user logs in, and the application interface will automatically switch to the chosen language. + +### Edit User Details + +Click **Edit** to update user information, including: + +- Profile avatar +- Name +- Phone number +- Company +- Job title +- Public profile +- Tagline +- Enable/disable DocumentId + +Edit Personal information + +Edit profile + +# ❌ Delete User (Admin Account) + +Follow these steps to permanently delete an admin account from OpenSign. + +### Steps to Delete Your Account + +1. **Open Profile Menu** – Click the profile menu and select **Profile**. +2. **Delete Account** – Scroll to the bottom and click **Delete Account**. Confirm by selecting **Yes**. +3. **Confirm via Email** – Open the deletion email and click **Confirm Account Deletion**. +4. **Send OTP** – On the next page, click **Send OTP**. +5. **Enter OTP** – Check your email for the OTP and enter it. +6. **Final Deletion** – Click **Delete Account**. All records and documents will be permanently removed. + +
+ +
+ +--- + +### Cases When Account Deletion is Not Allowed + +- **Team Users Exist** + If you have team users added under your account, you must delete them first before deleting your own account. + +- **Active Paid Plan** + If you have an active paid plan, you cannot delete your account directly. + To proceed with account deletion, please contact [support@opensignlabs.com](mailto:support@opensignlabs.com) for assistance. + +--- +If you need additional assistance setting up OpenSign APIs, feel free to contact our support team at support@opensignlabs.com. diff --git a/docs/docs/help/User Menu/_category_.json b/docs/docs/help/User Menu/_category_.json new file mode 100644 index 000000000..04ceda204 --- /dev/null +++ b/docs/docs/help/User Menu/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "User Menu", + "position": 6, + "link": { + "type": "generated-index", + "description": "5 minutes to learn everything about OpenSign™ User profile." + } +}