Using Account Keys, Organization Keys, and Agent Tags

Team: Huntress EDR
Product: Account keys, Organization Keys, Agent Tags
Environment: Huntress.IO management portal
Summary: The Huntress.IO portal allows you to organize your protected machines by account or organization using account keys, organization keys and names, as well as agent tags.

The Huntress Service employs two distinct identifiers, known as "keys," to link agents with the correct Account and Organization. These are referred to as your Account Key and Organization Keys. Additionally, you have the option to utilize Agent Tags for the purpose of categorizing and organizing your Agents within Organizations. For further information, please refer to the subsequent sections.

In this article

1Account Key

2Account Key Regeneration

3Organization Keys

4Organization Names

5Agent Tags

Account Key

To associate an Agent with the correct Huntress Account, a unique identifier known as an Account Key is utilized. This key is crucial during the installation process of the Huntress Agent, both in GUI and silent modes, and should be shared exclusively with individuals responsible for the installation of Huntress Agents. Given that your account is charged for each agent linked with this key, handling it with utmost security and discretion is essential. The key can be located through specific steps:

NOTE: Access to the account key, necessary for agent installation, is limited to account-level users. This restriction also applies to downloading the installer, implemented to prevent unauthorized installations of the agent, as the account incurs billing responsibilities.

1. Login to the Huntress Web Interface.

   

2. Hover over the Huntress options menu in the upper-right corner of the dashboard.

   

3. Select the "Download Agent" option from the menu.

   

4. On the Installer page you can retrieve your Account Key (and download the Huntress Agent installer while you are here).

Regenerating your Account Key

Should you need to Regenerate your Account key, this can be accomplished on the "Download Agent" page.

This change will not impact existing Huntress installations. However, for new installations and scripts, the updated key will be necessary.

The previous Account key will be deactivated and cease to function.

Organization Keys

Organization Keys are used to associate a Huntress Agent into a grouping we call Huntress Organizations. The Organization Key is typically a short, user-defined identifier that is required during Agent installation.

For RMM users, LabTech's ClientName, Continuum's SiteName, and Kaseya's MachineGroup are ideal examples as they'll automatically group your managed hosts into your pre-organized formats.

Note: If you're using a form of our PowerShell script to deploy the Huntress Agent, spaces in the "Organization Key" will be removed and the key will become one long string. If you are using the Huntress installer (either manually, through a script, or RMM such as ConnectWise Automate), any spaces in the Organization key will be turned into Dashes

We're big fans of automating mundane tasks and manually organizing agents is right next to watching paint dry. To help with this, the Huntress Web Interface will automatically create an Organization for you when a new agent registers with an Organization Key that doesn't already exist.

Organization Names

Since Organization Keys aren't always the prettiest names, we've also added the ability customize an Organization's display name from the Huntress Account's Organization Management page. Just take care and don't accidentally change the Organization Key or future agent installations may end up in a duplicate organization.

1. Navigate to your Account Dashboard by hovering over your account name in the upper-left corner and selecting the first option in the drop-down menu.

   

2. Select the "Organizations" option from the top navigation bar.

   

3. Click the pencil icon to edit the desired Organization.

   

4. Within the "Organization Name" field, change it to something more friendly. These display names will be used in the Huntress generated reports and throughout the Huntress Web Interface.

   

5. Voila! Pretty organization names are happy organization names ;)

   

Agent Tags

We've provided a way to add simple, descriptive words or phrases to each installed agent. We call these Agent Tags and they can be added during installation (manually or via a deployment script) or after installation (within the Huntress Web Interface). Tags allow you to group agents within your Organizations (and can only be seen in the Organization-scope). For example, you might tag all your servers with a "server" tag, add a tag to indicate the customer's location, or create a tag to indicate the machines function. An agent can have multiple tags, and the Search bar can find tags as well.

 

Editing tags in the Huntress Management Console

To change a tag in the Huntress Management Console, click on the "Agents" view and then click the pencil icon next to the tag:

The tags are comma-separated names. Press "enter" when done making the changes.