To perform administrative tasks on interfaces, ReqSuite® RM provides an interface management via a corresponding item in the administration menu. In the context of ReqSuite® RM “interfaces” are connecting data to other tools such as JIRA, TFS, AzureDevOps, GitLab, ClickUp, other ReqSuite® RM installations and user directories such as OpenLDAP, Active Directory or Azure Active Directory.

For creating (“Add Interface…” button), modifying (pencil icon), or deleting (trash icon) interfaces, or for checking the connection (check icon), ReqSuite® RM provides corresponding functionality via the “Interfaces” item in the administration menu (see Figure 1).

Since most functionality is quite self-explanatory, it will not be explained further here. Rather, the following explains what to consider when setting up different connections.

JIRA

ReqSuite® RM can be connected with both JIRA on-prem and JIRA cloud. However, when using ReqSuite® RM as SaaS and JIRA on-prem, it is necessary that the local firewall is open to allow connection from the cloud to the local server.

When setting up the actual connection, the host address including protocol, e.g., https://xxx.atlassian.net must be entered. Furthermore, instead of using a personal password, a (personal) access token (PAT)  must be used. This token can be generated in the settings area within JIRA or on id.atlassian.com.

TFS / AzureDevOps

ReqSuite® RM can be connected with TFS/AzureDevOps. However, when using ReqSuite® RM as SaaS and TFS/AzureDevOps on-prem, it is necessary that the local firewall is open to allow connection from the cloud to the local server.

When setting up the actual connection, the host address including protocol, e.g., https://xxx.visualstudio.com must be entered. Instead of using the personal password, it is alternatively possible to use a personal access token (PAT). This token must be generated in the settings area within TFS/AzureDevOps.

GitLab

ReqSuite® RM can be connected with both GitLab on-prem and GitLab in the cloud. However, when using ReqSuite® RM as SaaS and GitLab on-prem, it is necessary that the local firewall is open to allow connection from the cloud to the local server.

When setting up the actual connection, the host address including protocol, e.g., https://gitlab.com must be entered. Instead of using the actual user name, the user ID (number) is necessary. Furthermore, instead of the personal password, a (personal) access token (PAT) is required. This token can be generated in the settings area within GitLab.

ClickUp

ReqSuite® RM can be connected with ClickUp in the cloud.

When setting up the actual connection, the host address including protocol, e.g. https://api.clickup.com, must be specified. Instead of using the actual user name, the email address is necessary. Furthermore, instead of the personal password, a (personal) access token (PAT) is required. This token can be generated in the settings area within ClickUp.

Testrail

ReqSuite® RM can be connected with Testrail. However, when using ReqSuite® RM as SaaS and Testrail on-prem, it is necessary that the local firewall is open to allow connection from the cloud to the local server.

When setting up the actual connection, the host address including protocol, e.g., https://xxx.testrail.io must be entered. Instead of using the personal password the API key must be used which can be generated under “My Settings”.

Redmine

ReqSuite® RM can be connected with Redmine. However, when using ReqSuite® RM as SaaS and Redmine on-prem, it is necessary that the local firewall is open to allow connection from the cloud to the local server.

When setting up the actual connection, the host address including protocol, e.g., must be entered. Instead of using the personal password the API Key must be used which can be found on your account page under “/my/account” when logged in.

Other ReqSuite® RM Installations

ReqSuite® RM can be connected with other ReqSuite® RM installations including the cloud-based ReqSuite® RM on https://us.reqsuite.com or https://eu.reqsuite.com. However, when the invoking ReqSuite® RM instance is in the cloud and the invoked ReqSuite® RM instance is on-prem, it is necessary that the local firewall is open to allow connection from the cloud to the local server. In the other case, there shall not be any restrictions by default.

When setting up the actual connection, the host address including protocol, e.g., https://eu.reqsuite.com must be entered. The user account on the target system must have the default role “API User” as otherwise the connection will fail.

Active Directory

ReqSuite® RM can be connected with Active Directory. However, when using ReqSuite® RM as SaaS, it is necessary that the local firewall is open to allow connection from the cloud to the local server.

When setting up the actual connection, the host address including LDAP or LDAPs, e.g., LDAP://192.168.1.10 must be entered. The user name for establishing the connection can either be written in email syntax (e.g., admin@xxx.com) or LDAP syntax (e.g., cn=admin,dc=xxx,dc=com).

Other LDAP Directories (e.g., OpenLDAP)

ReqSuite® RM can be connected with other LDAP directories implementing the LDAP standard. However, when using ReqSuite® RM as SaaS, it is necessary that the local firewall is open to allow connection from the cloud to the local server.

When setting up the actual connection, the host address including LDAP or LDAPs, e.g., LDAP://192.168.1.10 must be entered. Furthermore, when using LDAPS, the port :636 must be added. If the LDAP directory uses a complex hierarchy it is necessary that the base address is used within the server adress, e.g., LDAP://192.168.1.10/o=xxx

The user name for establishing the connection must be written in LDAP syntax (e.g., cn=admin,dc=xxx,dc=com).

Azure Active Directory

ReqSuite® RM can be connected with Azure Active Directory.

When setting up the actual connection, the host address including the tenant name in Microsoft (not in ReqSuite® RM) must be used, e.g., https://graph.microsoft.com/xxx. Furthermore, ReqSuite® RM must be registered as an app in the Azure Active Directory and the following API rights must be granted for the application: Directory.Read.All, Group.Read.All, GroupMember.Read.All, User.Read.All

Instead of using a user name, the client ID of the app generated by Azure Active Directory must be entered. The same holds true for the password. Instead of entering a personal password, a client secret generated by Azure Active Directory must be used.

Google User Management

ReqSuite® RM can be connected with Google Workspace.

When setting up the actual connection, the following URL must be entered for the server address https://admin.googleapis.com/YOURDOMAIN, e.g. https://admin.googleapis.com/osseno.de. Furthermore, a service account must be created with domain-wide delegation for the scopes admin.directory.user.readonly and admin.directory.group.readonly.

The e-mail address of the service account must be entered as the user name and for the token you have to enter the private key of the service account.