--- title: User Enablement Guide slug: docs/user-enablement-guide docTags: createdAt: 2026-04-21T21:46:54.682Z --- ### Documentation - The full list of detectors and analyzers are available here: - [https://trufflesecurity.com/detectors](https://trufflesecurity.com/detectors) - [https://trufflesecurity.com/analyzers](https://trufflesecurity.com/analyzers) - To access the TruffleHog API documentation do the following: - Log into your TruffleHog instance - In the left navigation bar, click on “Documentation” - Click on “API Docs” - If you have questions about the terminology used throughout this document, please reference this page: - [https://docs.trufflesecurity.com/terminology](https://docs.trufflesecurity.com/terminology) - You can export your secret findings in a CSV file and this guide explains each column name. - [https://docs.trufflesecurity.com/exported-secrets-column-definitions](https://docs.trufflesecurity.com/exported-secrets-column-definitions) ### Adding Users - To add a user, within TruffleHog click on “Settings”, then click on “Users”. Enter the user's email address, select their role and then click “Add User”. ::Image[]{src="https://api.archbee.com/api/optimize/S23bFlGfp3a-8_a9YY_cE/f5KB1yXC_3XO0iIXJa3vk_image.png" size="30" width="300" height="939" position="flex-start" darkWidth="300" darkHeight="939" showCaption="false"} - Enter email address and select role. ![](https://api.archbee.com/api/optimize/S23bFlGfp3a-8_a9YY_cE/qpzxORm7Tt8SRlU9Ja0PP_image.png) ### Deleting Users - To delete a user, within TruffleHog click on “Settings”, then click on “Users”. Find the user's email address and click "Remove" on the right side of the user record. ![](https://api.archbee.com/api/optimize/S23bFlGfp3a-8_a9YY_cE/SNVmnA7qXf9uKVXYiz93A_image.png) ### User Roles Explained :::Paragraph{listStyleType="disc" indent="2"} **Admin** - Admins have full editor permissions as well as managing users and authentication. ::: :::Paragraph{listStyleType="disc" indent="2"} **Editor** - People with editor access have read and write access to TruffleHog. They can set up integrations, adjust secret triage states, and most other changes. Editors cannot manage users or authentication. ::: :::Paragraph{listStyleType="disc" indent="2"} **Viewer** - People with viewer access have read-only access to TruffleHog. They can see metrics, explore discovered secrets, and view any other data available. Viewers cannot make changes. ::: :::Paragraph{listStyleType="disc" indent="2"} **Share Viewer** - People with share viewer access have read-only access to the TruffleHog secrets you share with them directly like this: ::: ![](https://api.archbee.com/api/optimize/S23bFlGfp3a-8_a9YY_cE/iHP72dHUwtEJU7ZpvrsO1_image.png) **\*\* For more information about setting up"Dynamic Role-Based Access" please follow this document:** - [https://docs.trufflesecurity.com/dynamic-role-based-access-control-rbac](https://docs.trufflesecurity.com/dynamic-role-based-access-control-rbac) **Setting up Single Sign-On (SSO)** - To setup SSO, please follow the guide available here: - [https://docs.trufflesecurity.com/authentication](https://docs.trufflesecurity.com/authentication) **TruffleHog API** - **Accessing Documentation** - To access the TruffleHog API documentation do the following: - Log into your TruffleHog instance - In the left navigation bar, click on “Documentation” - Click on “API Docs” - **Creating an API Key** - To create a TruffleHog API key, do the following: - Log into your TruffleHog instance - In the left navigation bar, click on “Settings” - Click on “API Keys” - Click on "Generate API Key" - Name your key and select an expiration date (Never, 1 day, 7 days, 3 months, 1 year) and click "Add API Key" - Copy the "API Key ID" and "API Key Secret" and store it in a secure place ("Download as JSON" or copy via clipboard icon) - Click "Done" ::Image[]{src="https://api.archbee.com/api/optimize/S23bFlGfp3a-8_a9YY_cE/xT-Aym9DGGPjceNQXEHbg_image.png" size="50" width="602" height="1174" position="flex-start" darkWidth="602" darkHeight="1174" showCaption="false"} ### Dashboard - **Insights** - **Live Secrets** - this graph shows a **current total** and view over the last 6 months of all live secrets. - **Live** means that we found the secret in one of your environments and were able to *successfully make a safe, read-only API call to the service provider to test if the credential is valid without modifying any resources.* - (Optional) More information about HOW TruffleHog verifies secrets is available here: - [https://trufflesecurity.com/blog/how-trufflehog-verifies-secrets](https://trufflesecurity.com/blog/how-trufflehog-verifies-secrets) - Clicking on "Take me there" will take you to the "Secrets" page pre-filtered to show only **Live** secrets ![](https://api.archbee.com/api/optimize/S23bFlGfp3a-8_a9YY_cE/msKRoiGyl1VqtpHg5UaC4_image.png) :::Paragraph{listStyleType="disc" indent="2"} **Secrets** **Discovered **- this graph shows a total count of all **live** secret locations discovered across your sources. ::: :::Paragraph{listStyleType="disc" indent="3"} Users can click on any bar in the graph and it will take them to the "Secrets" page pre-filtered to show only Live secrets for that Secret type. ::: :::Paragraph{listStyleType="disc" indent="4"} Example - Clicking on AWS will take you to a view of all live AWS secrets. ::: :::Paragraph{listStyleType="disc" indent="3"} Clicking on "View all secret types" will take you to the "Secrets" page pre-filtered to show only **Live** secrets ::: ![](https://api.archbee.com/api/optimize/S23bFlGfp3a-8_a9YY_cE/Cp9l-GD2hBxt2kvbWbJrO_image.png) :::Paragraph{listStyleType="disc" indent="2"} **Days on average to rotate** - this graph shows the days on average that it takes your team to rotate the secrets that TruffleHog finds. The graph shows the last 6 months with each dot representing a bi-weekly data point. ::: :::Paragraph{listStyleType="disc" indent="2"} **Save as PDF** - Users can also save a pdf version of this page by clicking "Save as PDF" in the top-right corner. ::: ![](https://api.archbee.com/api/optimize/S23bFlGfp3a-8_a9YY_cE/65DuNN924J706hytFBdaO_image.png) - **Active Scans** - The "Active Scans" view shows any scans that are currently running. ### Secrets Page - Clicking "Secrets" in the left navigation panel will take you to the Secrets page where you can initially filter Secrets based on the following: - Secret state - Triage state - Definitions of the secret state and triage state options are available here: - [https://docs.trufflesecurity.com/terminology](https://docs.trufflesecurity.com/terminology) - Clicking "Filters" in the top-right corner displays even more options that you can filter on. - You can save your filters. ::Image[]{src="https://api.archbee.com/api/optimize/S23bFlGfp3a-8_a9YY_cE/l3Ut2uPvHnLdWP2Wjp1oG_image.png" size="50" width="401" height="730" position="flex-start" darkWidth="401" darkHeight="730" showCaption="false"} - **Additional filters include:** - **Secret type** - The kind of secret that was found. - Ex. AWS Access Key, MongoDB credential, HuggingFace API Key, GitHub PAT - **Source type** - Where / which system the secret was found in - Ex. GitHub Repository, Slack channel, Confluence Page - **Source name** - The name / identifier of the source / integration you created. This is done on the "Integrations" page and more information can be found later in this document - Examples of different source names can be found below. Notice that the tool / system is provided in parentheses for each item. ::Image[]{src="https://api.archbee.com/api/optimize/S23bFlGfp3a-8_a9YY_cE/iyltdEel6YoDLrYmZnugH_image.png" size="50" width="320" height="494" position="flex-start" darkWidth="320" darkHeight="494" showCaption="false"} :::Paragraph{listStyleType="disc" indent="2"} **Scanner name** ::: :::Paragraph{listStyleType="disc" indent="3"} The "Scanner name" filter lets you filter based on your **Hosted** scanners (i.e. Managed Scanners hosted by Truffle Security Co.) and your self-hosted scanners. ::: :::Paragraph{listStyleType="disc" indent="4"} You can view the full list of these scanners by clicking "Settings" then "Scanners" in the left-side navigation menu. ::: :::Paragraph{listStyleType="disc" indent="2"} **Location type** ::: :::Paragraph{listStyleType="disc" indent="3"} The "Location type" filter lets you filter based on WHERE a secret was found. ::: ::Image[]{src="https://api.archbee.com/api/optimize/S23bFlGfp3a-8_a9YY_cE/Q3AdsgSU6L2OWsFqkxjFO_image.png" size="50" width="346" height="369" position="flex-start" darkWidth="346" darkHeight="369" showCaption="false"} **Connection issues** :::Paragraph{listStyleType="disc" indent="3"} The "Connection issue" filter lets you filter based on the type of connection issue we encountered when we tried to verify the found secret(s) ::: ::Image[]{src="https://api.archbee.com/api/optimize/S23bFlGfp3a-8_a9YY_cE/NReyQhm6OIQlE0ZHrgDSM_image.png" size="50" width="335" height="384" position="flex-start" darkWidth="335" darkHeight="384" showCaption="false"} - **TruffleHog Analyze** - An overview of Analyze can be found [here](https://trufflesecurity.com/trufflehog-analyze?utm_term=\&utm_campaign=TruffleHog+Enterprise+Branded+Search\&utm_source=adwords\&utm_medium=ppc\&hsa_acc=8912163847\&hsa_cam=22653195511\&hsa_grp=183698441987\&hsa_ad=756770992257\&hsa_src=g\&hsa_tgt=dsa-2425737624459\&hsa_kw=\&hsa_mt=b\&hsa_net=adwords\&hsa_ver=3\&gad_source=1\&gad_campaignid=22653195511\&gbraid=0AAAAACREmvKldSbzN78N_7iUSjLtQcz5C\&gclid=Cj0KCQjwh-HPBhCIARIsAC0p3ceSAtkC8reL-Xn9H8Mo6N7CMeqZykst094GcnTtXIbDGwyHzC2iUn8aAqYAEALw_wcB), and for additional context, please checkout [Analyze Secrets](https://docs.trufflesecurity.com/analyzers). - [60+ Analyzers](https://trufflesecurity.com/analyzers) available. - The "TruffleHog Analyze" filter lets you filter by the type of Analyzer (ex. Square, OpenAI, Mailchimp) and the permissions (ex. "read", "write", etc.) associated with that Analyzer. - **Discovered Secrets** - The "Discovered Secrets" tab shows a list / table of all secrets that match the current filter set. - The "Secret Locator" and "Location" table headers can be clicked to sort the table in alphabetical order - The "Found On" and "Last Seen" table headers can be clicked to sort the table in order by timestamp. - Additional actions can be found for each item in the "Actions" column ::Image[]{src="https://api.archbee.com/api/optimize/S23bFlGfp3a-8_a9YY_cE/1yC04PazoWkiB0X29t7fZ_image.png" size="50" width="320" height="240" position="flex-start" darkWidth="320" darkHeight="240" showCaption="false"} :::Paragraph{listStyleType="disc" indent="2"} Each individual secret can be clicked on to navigate to the "Secret Details" view. ::: ### Analyze - How to Filter all Live Secrets - When you open secrets on the left, you will not see Truffle Analyze Search box to the right of Triage State. ![](https://api.archbee.com/api/optimize/S23bFlGfp3a-8_a9YY_cE/zzIOpcvJ5E_dgXbI_kcPv-20260121-210602.png) - To get the Analyze search box, go to one of your secrets that has been identified by Analyze, like this Slack token. - Left click any permission and click Add to Filter. ![](https://api.archbee.com/api/optimize/S23bFlGfp3a-8_a9YY_cE/nJ4b0CqAtMuwwhcVkNCqG_image.png) - The bottom notification displays. - Click Filter by 1 Permission. ![](https://api.archbee.com/api/optimize/S23bFlGfp3a-8_a9YY_cE/Eln9VYGvbW3yXEy72YVtH_image.png) - The Dashboard redirects you back to Secrets and surfaces the TruffleHog Analyze BETA search box to filter. ![](https://api.archbee.com/api/optimize/S23bFlGfp3a-8_a9YY_cE/lRaU7Q4VfT__CaZOBoygc-20260121-205818.png) - Filter by ALL to see all exposed live secrets ![](https://api.archbee.com/api/optimize/S23bFlGfp3a-8_a9YY_cE/zk6fPFaPOWdXsY8A03kzd_image.png) - These are all of the suraced live secrets under Discovered Secrets - Click into any of these below under Secret Locator to See their Access Permissions. ![](https://api.archbee.com/api/optimize/S23bFlGfp3a-8_a9YY_cE/5jArdxEiLhejKsMvNOjkO_image.png) - Click Open AI Secret to See Permissions as an example ![](https://api.archbee.com/api/optimize/S23bFlGfp3a-8_a9YY_cE/KNj1Zydxsd1lVo_7C9_7a_image.png) ### Forager - Forager diligently monitors public commits on Github and package releases on NPM, looking for leaked secrets. - The "Forager" tab shows the total verified keys, key types and user leaked credentials found across those platforms for a given email domain (ex. trufflesec.com). ![](https://api.archbee.com/api/optimize/S23bFlGfp3a-8_a9YY_cE/_XockV9L0Xmg2C5waif9k_image.png) More information about Forager is available at the links below: :::Paragraph{listStyleType="disc" indent="2"} [https://forager.trufflesecurity.com/](https://forager.trufflesecurity.com/) ::: :::Paragraph{listStyleType="disc" indent="2"} [https://trufflesecurity.com/blog/introducing-forager](https://trufflesecurity.com/blog/introducing-forager) :::