> For the complete documentation index, see [llms.txt](https://docs.harmony.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.harmony.io/integrations/saas-applications/testrail.md).

# TestRail

The TestRail integration connects your test management platform to Harmony, giving your team full visibility into user access, roles, and license allocation across your organization. Once connected, Harmony pulls in user and license data from your TestRail instance so you can monitor who has access and how licenses are being used. TestRail appears as a managed application in Application Management, complete with license and cost data.

### Prerequisites

Before setting up the integration, make sure you have:

* A TestRail account with administrative access
* Your TestRail subdomain
* The email address associated with your TestRail admin account
* A TestRail API key or password for authentication

### Connecting TestRail to Harmony

To connect your TestRail instance:

1. In Harmony, go to **Settings** then **Integrations**.
2. Find TestRail under the **Development / QA** category, or search for it by name.
3. Click **Connect**.
4. Enter the following details when prompted:
   * **Subdomain** - your TestRail subdomain (for example, `yourcompany` if your TestRail URL is `yourcompany.testrail.io`)
   * **Email** - the email address of your TestRail admin account
   * **API key** - your TestRail API key or account password
5. Click **Save** to complete the connection.

Once connected, Harmony begins syncing user and license data from your TestRail instance.

### What Harmony Syncs from TestRail

After the integration is active, Harmony collects the following data from your TestRail instance:

* **Users** - all users in your TestRail account, including their names and email addresses
* **Roles** - the role assigned to each user within TestRail
* **License data** - how licenses are allocated across your organization, including which users are consuming licenses

### Viewing TestRail Data in Harmony

Once synced, you can access your TestRail data in the following places:

* **Application Management** - TestRail appears as a managed application, where you can review license counts, cost data, and overall usage.
* **User profiles** - individual users show their TestRail access and role assignments alongside other application data.

### Managing Access and Licenses

With TestRail connected as a managed application, you can:

* Identify users who hold TestRail licenses and what roles they have been assigned
* Spot unused or underutilized licenses to optimize spend
* Compare TestRail access against your organization's broader SaaS footprint

### Disconnecting TestRail

To remove the TestRail integration:

1. Go to **Settings** then **Integrations**.
2. Locate TestRail and click **Disconnect**.
3. Confirm the disconnection when prompted.

After disconnecting, Harmony stops syncing data from TestRail. Historical data already collected may still appear in reports depending on your data retention settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.harmony.io/integrations/saas-applications/testrail.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.