You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Current »

Overview

While standard integrations often use Personal API Tokens, many organizations prefer using Service Accounts for production environments to ensure continuity and enhanced security. This method utilizes Jira’s Scoped API Keys, which allow you to restrict the integration's access to specific actions and data within your Jira instance.

Use this guide if:

  • You are connecting Enterprise Tester to a Jira Cloud instance.

  • Your organization requires the use of a non-human Service Account.

  • You are using Scoped API Keys rather than individual Personal API Tokens.

Technical Requirements

To use Scoped API Keys, Enterprise Tester requires a specific URL configuration. Unlike standard tokens that use your direct subdomain for all fields, Scoped API Keys require you to provide both the API Gateway address (Application URL) and your Front-end Jira URL (Display URL).

1. Mandatory Service Account Usage

Enterprise Tester exclusively supports Scoped API Keys when paired with an official Atlassian Service Account.

  • Service Account Email: Must follow the Atlassian-managed format: name@serviceaccount.atlassian.com.

  • Why? This specific domain suffix allows ET to correctly identify the traffic as Scoped API traffic and apply the necessary routing logic.

2. Identifying your Site ID

Because Scoped API Keys route through the api.atlassian.com gateway, you must provide your unique Site ID.

  • To find your Site ID: Navigate to https://<your-subdomain>.atlassian.net/_edge/tenant_info in your browser.

  • Locate the ID: Find the value for "cloudId". It will be a string similar to 1234abcd-5678-efgh-9012-ijklmnop3456.

Configuration Settings

When adding or editing your Jira connection in the Edit External System screen, use the following field mappings:

FieldRequired Value / Format
Application URLhttps://api.atlassian.com/ex/jira/<Your-Site-ID>/
Display URLYour front-end Jira address: https://<subdomain>.atlassian.net/
UsernameYour Service Account email: name@serviceaccount.atlassian.com
PasswordYour Scoped API Key (entered into the Password field)

Understanding the URL Fields

  • Application URL: This is the technical endpoint Enterprise Tester uses to communicate with Jira's API. It must include the api.atlassian.com prefix and your specific Site ID.

  • Display URL: This is the user-facing URL. Enterprise Tester uses this to generate clickable links within the application so your team can jump directly to issues in the Jira UI.

  • No labels