Join 34,000+ subscribers and receive articles from our blog about software quality, testing, QA and security.

How to modify testrail users using testrail API


We have many users who left company but still active in Testrail. I am looking for programmatic way to modify users as disabled. I can get list of almost 500 users who should get deactivated.

Can you please provide method which can be performed on DB for disabling users.


Hi Vivek,

Thanks for your posting. TestRail’s API only has read-only support for users (get_users) and we would recommend changing the status in the UI on Administration > Users & Roles instead. You can quickly toggle the Active status on the overview page with the dropdown. Please don’t change anything directly in TestRail’s database as this would be unsupported and may result in an unusable database.



Thanks Tobias, I am running Testrail user audit and found that 562 users should be disabled. I am not willing to disable these many accounts through UI.

are you guys are planning to add_user functionality in Testrail API?


Hi Vivek,

Thanks for your feedback. There are currently no immediate plans but we are happy to look into this and I agree that an add_user and/or update_user API would be great to have in this case. We would currently recommend deactivating the users in the UI and you can quickly change the Active status on the overview page per user.



Thanks Tobias, add_user and update_user functionality in API will help in performing the close integration between Testrail and other user authentication such as Crowd, LDAP or AD.


Hi Vivek,

For TestRail Server, there’s already a different API/integration for external authentication services you can use and we offer ready to use scripts for LDAP and Active Directory:

This integration can also auto-add TestRail users based on the LDAP/AD login and authentication (AUTH_CREATE_ACCOUNT option).

I hope this helps!



Understand the LDAP/AD integration, however we have an internal application in which users request access to TestRail (tied to AD). It would be great if we could add users via API to TestRail and a project without having the user login to have their account created, even in this scenario we have to go into TestRail to add them to a project/role etc. Are there any enhancements on your backlog for additional user maintenance functionality? If so is there an ETA?

Thank you.


Any chance of adding API access directly (without using the LDAP/AD integration)?
We are unable to implement the existing LDAP solution due to restrictions by our CyberSecurity team (we really need SAML). An API option to add/edit users would all us to give project ‘admins’ the ability to manage their users, while continuing to restrict TestRail Admin (global) permissions to a limited number of users. User management hasn’t been too bad to manage manually with 500 users, but we’re upgrading to 2,000 users and ~150 projects.


Hi, I just wanted to add to this that our organization would
benefit greatly from addition of these API endpoints as well.
The task of manually updating user records in the UI does
not scale well beyond a certain number.