TestRail Integration with AuthPoint

Contents

Deployment Overview

This document describes how to set up multi-factor authentication (MFA) for TestRail with AuthPoint as an identity provider. TestRail must already be configured and deployed before you set up MFA with AuthPoint.

TestRail can be configured to support MFA in several modes. For this integration, we set up SAML with AuthPoint.

This integration was tested with v7.8.0 of TestRail Enterprise Cloud.

TestRail Authentication Data Flow with AuthPoint

AuthPoint communicates with various cloud-based services and service providers with the SAML protocol. This diagram shows the data flow of an MFA transaction for TestRail.

Diagram that shows the data flow of an MFA transaction for a SAML resource with the push authentication method.

Before You Begin

Before you begin these procedures, make sure that:

Configure TestRail

To start, you must download the metadata file from the Certificate Management page in the AuthPoint management UI. After you have that, you can configure TestRail.

  1. Log in to WatchGuard Cloud.
  2. From the navigation menu, select Configure > AuthPoint. If you have a Service Provider account, you must select an account from Account Manager.
  3. Select Resources.

Screenshot that shows the Certificate button on the Resources page.

  1. Click Certificate.
  2. Next to the AuthPoint certificate you will associate with your resource, click and select Download Metadata. We recommend that you choose the certificate with the latest expiration date. If you do not have a certificate, or if all of your certificates have expired, click Add Certificate and use the newly created certificate.

    The AuthPoint metadata provides your resource, in this case TestRail, with the information necessary to identify AuthPoint as a trusted identity provider.

Screenshot of the Certificate Management page.

  1. Log in to TestRail as an administrator.
  2. Select Administration > Site Settings > SSO.

Screenshot of TestRail SSO page.

  1. From the Select Your Authentication Protocol drop-down list, select SAML 2.0.
  2. Copy the Entity ID and Single Sign On URL values. You need this information when you configure AuthPoint.
  3. Open the AuthPoint metadata file you downloaded in Step 5 and find the entityID, SingleSignOnService Location, and X509 Certificate values.
  4. In the IDP SSO URL text box, type or paste the SingleSignOnService Location value from the AuthPoint metadata file.
  5. In the IDP Issuer URL text box, type or paste the entityID value from the AuthPoint metadata file.
  6. (Optional) Select the Authentication Fallback check box.
  7. (Optional) Select the Create Account on First Login check box.
  8. In the IDP Certificate text box, paste the X509Certificate value from the AuthPoint metadata file.
  9. Click Save Settings.

Configure AuthPoint

Before AuthPoint can receive authentication requests from TestRail, you must add a SAML resource in AuthPoint. You must also create an authentication policy for the TestRail resource to determine which users can authenticate and log in to TestRail and which authentication methods they can use (Push, QR code, and OTP).

Add a SAML Resource in AuthPoin

From the AuthPoint management UI:

  1. From the navigation menu, select Resources. Click Add Resource.
    The Add Resource page opens.

  1. From the Type drop-down list, select SAML.
    Additional fields appear.

  1. On the SAML page, in the Name text box, type a name for this resource.
  2. From the Application Type drop-down list, select Others.
  3. In the Service Provider Entity ID text box, type or paste the Entity ID value you copied from the TestRail in the Configure TestRail section.
  4. In the Assertion Consumer Service text box, type or paste the Single Sign On URL value you copied from the TestRail in the Configure TestRail section.
  5. From the User ID sent on redirection to service provider drop-down list, select an option:
    • Email
    • User Name
    • Email Prefix
  6. From the Signature Method drop-down list, select SHA-256.
  7. From the AuthPoint Certificate drop-down list, select the certificate to associate with your resource. This must be the same certificate that you downloaded the metadata for in the Configure TestRail section.
  8. In the Custom Attributes section, click Add Attribute.
    The Add Attribute window opens.
  9. In the Attribute Name text box, type FirstName.
  10. From the Get Value From drop-down list, select User First Name.
  11. Click Save
  12. Repeat steps 10-13 to create the other two attributes.

Screenshot of AuthPoint resource page.

  1. Click Save.

Add a Group in AuthPoint

You must have at least one user group in AuthPoint to configure MFA. If you already have a group, you do not have to add another group.

To add a WatchGuard Cloud-hosted group to the WatchGuard Cloud Directory:

  1. Go to Configure > Directories and Domain Services.
  2. Click the WatchGuard Cloud Directory domain name. If you have not yet added the WatchGuard Cloud Directory, click Add Authentication Domain and select the WatchGuard Cloud Directory.
    The New Group page appears.

Screenshot that shows the Directories and Domain Services page.

  1. In the Groups tab, click Add Group.
  2. In the Group Name text box, type a descriptive name for the group.
  3. (Optional) In the Description text box, type a description of the group.

Screen shot of the Add Group page.

  1. Click Save.
    Your group is added to the WatchGuard Cloud Directory and to AuthPoint.

Add an Authentication Policy to AuthPoint

Authentication policies specify which resources users can authenticate to and which authentication methods they can use (Push, QR code, and OTP).

You must have at least one authentication policy in AuthPoint that includes the TestRail resource. If you already have authentication policies, you do not have to create a new authentication policy. You can add this resource to your existing authentication policies.

Users that do not have an authentication policy for a specific resource cannot authenticate to log in to that resource.

To configure an authentication policy:

  1. From the navigation menu, select Authentication Policies.
  2. Click Add Policy.

Screenshot of the Add Policy button on the Authentication Policies page.

  1. Type a name for this policy.
  2. From the Select the Authentication Options drop-down list, select Authentication Options and select which authentication options users can choose from when they authenticate.

    For SAML resources, if you select more than one authentication option, users must select one of the available options when they authenticate. For example, if you select OTP and Push, users can choose to type their OTP or approve a push to authenticate. You cannot require that they do both.

  1. Select which groups this policy applies to. You can select more than one group. To configure this policy to apply to all groups, select All Groups.
  2. Select the resource that you created in the previous section. If you want this policy to apply to additional resources, select each resource this policy applies to. To configure this policy to apply to all resources, select All Resources.

Screenshot of the Add Policy page with the groups and resources selected

  1. (Optional) If you have configured policy objects such as a Network Location, select which policy objects apply to this policy. When you add a policy object to a policy, the policy only applies to user authentications that are the same as the conditions of the policy objects. For example, if you add a Network Location to a policy, the policy only applies to user authentications that come from that Network Location. Users who only have a policy that includes a Network Location do not get access to the resource when they authenticate outside of that Network Location (because they do not have a policy that applies, not because authentication is denied).

    If you configure policy objects, we recommend that you create a second policy for the same groups and resources without the policy objects. The policy with the policy objects should have a higher priority.

Screenshot of the Policy Objects drop-down list.

  1. Click Save.
    Your policy is created and added to the end of the policy list.

    When you create a new policy, we recommend that you review the order of your policies. AuthPoint always adds new policies to the end of the policy list.

Screenshot of the Save button on the Add Policy page.

Add Users to AuthPoint

Before you assign users to a group, you must add the users to AuthPoint. There are two ways to add AuthPoint user accounts:

  • Sync users from an external user database
  • Add WatchGuard Cloud-hosted AuthPoint users

Each user must be a member of a group. You must add at least one group before you can add users to AuthPoint.

To import users from Active Directory, Microsoft Entra ID, or an LDAP database, you must add an external identity in the AuthPoint management UI. External identities connect to user databases to get user account information and validate passwords.

  • To sync users from Active Directory or an LDAP database, you must add an LDAP external identity
  • To sync users from Microsoft Entra ID, you must add a Microsoft Entra ID external identity

When you sync users from an external user database, you can sync any number of users and they are all added to AuthPoint at one time. Users synced from an external user database use the password defined for their user account as their AuthPoint password.

To learn how to sync users, go to Sync Users from Active Directory or LDAP and Sync Users from Azure Active Directory.

You create WatchGuard Cloud-hosted users and groups from the WatchGuard Cloud Directory in WatchGuard Cloud. Directories and Domain Services is where you add shared authentication domains for WatchGuard Cloud devices and services, such as AuthPoint.

Users that you add to the WatchGuard Cloud Directory are automatically added to AuthPoint as well.

You add local AuthPoint users form Directories and Domain Services. You manage the users in AuthPoint on the Users page.

When you add WatchGuard Cloud-hosted AuthPoint users, you choose whether the user is an MFA user or a non-MFA user.

  • MFA users are user accounts that will use AuthPoint multi-factor authentication to authenticate. This is not related to the AuthPoint Multi-Factor Authentication license type.
  • Non-MFA users are users that will only ever authenticate with a password, such as a service account user. Non-MFA users do not consume an AuthPoint user license and cannot authenticate to resources that require MFA. They can only authenticate to protected resources if the non-MFA user account has a password only authentication policy for that resource.

After you add a user, you can edit the user account if you need to change their account type. When you change a user account from MFA to non-MFA, AuthPoint deletes the tokens and password vault (if applicable) that belong to the user. This action cannot be undone.

Unlike users synced from an external user database, WatchGuard Cloud-hosted AuthPoint users define and manage their own AuthPoint password. When you add a WatchGuard Cloud-hosted user account, the user receives an email that prompts them to set their password.

To learn how to add WatchGuard Cloud-hosted AuthPoint user accounts to the WatchGuard Cloud Directory, go to Add Local Users to an Authentication Domain.

Test the Integration

To test AuthPoint MFA with TestRail, you can authenticate with a mobile token on your mobile device. For SAML resources, you can choose any method (push, QR code, or one-time password).

In this example, we show the push authentication method (users receive a push notification in the mobile app that they must approve to authenticate).

  1. In a web browser, go to the TestRail URL.
  2. Click Single Sign On.
  3. Type your email address or AuthPoint user name. Click Next.
  4. If required, in the Password text box, type your password.
  5. For the authentication method, select Send Push.
  6. Approve the authentication request that is sent to your mobile device.
    You are logged in to TestRail.