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.
Key Differences & Requirements
Integrating via Scoped API Keys changes how Enterprise Tester communicates with Jira. Unlike standard tokens that use your direct subdomain URL, Scoped API Keys route through Atlassian’s specialized API gateway.
1. Mandatory Service Account Usage
To ensure security and predictable configuration, Enterprise Tester exclusively supports Scoped API Keys when paired with an official Atlassian Service Account.
Identification: Your Service Account email must follow the Atlassian-managed format:
name@serviceaccount.atlassian.com.Why? This specific domain allows ET to automatically apply the correct logic for Scoped API traffic.
2. The API Gateway URL
Scoped API Keys do not use the standard .atlassian.net base URL. Instead, they require the Atlassian API domain.
Standard URL:
https://your-company.atlassian.netScoped API URL:
https://api.atlassian.com/ex/jira/<Site-ID>
3. Locating Your Site ID
Because Scoped API Keys require the API Gateway URL, you must provide your unique Site ID (also known as a Cloud ID). This is a unique identifier for your Jira instance that replaces your subdomain in the connection string.
How to find your Site ID: In your browser, navigate to:
https://<your-subdomain>.atlassian.net/_edge/tenant_info. Look for the"cloudId"value (e.g.,1234abcd-5678-efgh-9012-ijklmnop3456).