Introduction to Custom Authentication Scripts

Authentication: Introduction

TestRail can be integrated with external systems to implement single sign-on functionality. To support this, TestRail can be extended with a custom authentication script that validates the username and password users enter on TestRail’s login screen.

Scripts

We provide ready-to-use sample scripts to integrate TestRail’s authentication with Active Directory services and databases. Do you need to integrate TestRail with another system? Please see below for information on how to build your own single sign-on integration.

Script	Description
Active Directory	Integrate TestRail with Windows Active Directory services to implement single sign-on and to create initial user accounts. Make sure to read the full documentation.
LDAP	Integrate TestRail with LDAP services to implement single sign-on and to create initial user accounts. Make sure to read the full documentation.

Available Options

A script can validate the login credentials by querying external systems such as Active Directory, LDAP servers, by verifying the data in an external database or by querying external APIs. By allowing administrators to use a custom script to integrate TestRail with external authentication systems, TestRail can be integrated with almost any third-party authentication system or application.

Authentication scripts can also ask TestRail to create new user accounts for users whose credentials could be validated but don’t have a TestRail account yet. This is a great way to create all the necessary user accounts in your organization without creating TestRail accounts manually. Our Active Directory script (see below) fully supports this feature.

Custom Scripts

It’s also possible to build your own custom authentication scripts. This can be useful to integrate TestRail with internal authentication systems:

• Building a custom single sign-on integration

Contribute

Want to contribute to existing integration scripts or have you developed your own integration? We welcome any contributions and you can access the full source code of the above scripts from the GitHub repository.