⚠️ Warning
This integration setup is for Atlassian Jira Cloud only. If your set-up is not Cloud (Server or Data Center), please consult our Atlassian Application Tunnel Documentation.
1. How does SQAI Suite Leverage This Integration?
Connecting to Jira allows SQAI to integrate directly into your development and QA workflow, transforming requirements into actionable testing assets:
Contextual Analysis: SQAI reads your user stories, tasks, and issues from Jira to gain the necessary business context for accurate generation.
Test Case Linkage: Allows SQAI to link newly generated test cases and automation scripts back to the original Jira issue for full traceability.
Efficient Reporting: Provides a clear (promptable) link between generated testing assets and the original work item in Jira
2. Information Required from Your Jira Account
To establish a secure, plug-and-play connection, we require three pieces of information, plus a secure API key/token.
Required Detail | Explanation | Example Value |
Cloud Instance URL | The base URL of your Atlassian Cloud site. |
|
Username (Email) | The email address associated with the account used to generate the API key. | |
API Key / Token | A secure token generated in your Atlassian settings (Classic or Scoped). | See Section 3. |
3. Setting up the API Key
For the Jira Cloud integration, a personal user account or a service account needs to be used to generate the required API key. You can use either a Classic Token or a Scoped Token (recommended). For more info: Manage API tokens for your Atlassian account | Atlassian Support
3.1 Generating a Classic Token
This method is simpler but grants broader access (full user permissions for the generating account).
Navigate directly to your API token management page
Click Create API token and name it (e.g., "SQAI Jira Integration").
Copy the generated token immediately.
3.2 Generating a Scoped Token (Recommended)
This method uses the newer Scoped Token framework to ensure the token only has the specific, minimal read permissions SQAI needs to gather context.
Follow the steps in the Jira UI to create a new Scoped Token.
You must ensure the token includes the following extensive list of read scopes to fully capture all issue details, attachments, project boards, and metadata needed for contextual generation:
Scope | Type of Scope |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Platform (Core) |
| Jira Software |
| Jira Software |
| Jira Software |
| Jira Software |
| Jira Software |
| Jira Software |
| Jira Service Management |
| Jira General (Classic) |
Reference: For more info on managing API tokens and scopes, see: Manage API tokens for your Atlassian account | Atlassian Support
4. Entering Details in SQAI Suite
Once you have secured your API Key/Token, you can complete the setup in the SQAI Suite platform.
Step 1: Navigate to Integrations Go to your SQAI Suite settings and select the Integrations page. Find and select the Atlassian Jira configuration.
Step 2: Enter Details Insert the gathered information into the corresponding fields:
Cloud Instance URL (only change if you have a custom URL)
Username (Email)
API Key / Token
(Optionally: Experation Date)
Step 3: Save and Confirm Click "Save Configuration." If the set-up is successful, you will receive a success message and see a green indicator next to your Jira integration.
5. Troubleshooting Jira Integration
If SQAI reports an error or fails to connect, use this checklist to quickly identify and resolve the most common issues related to access and context retrieval.
Problem | Cause | Solution |
Connection Failed: "Unauthorized" or "Access Denied" | A. Missing Scopes: The API Key (especially Scoped Token) is missing one or more of the necessary read scopes listed in Section 3.2. | Verify Scopes: Check the API Key permissions against the extensive list of required read scopes. The token must have read access to all necessary work item details. |
Cannot Find Issues/Boards | B. Incorrect Cloud ID/URL: The Cloud Instance URL or Cloud ID is incorrect. | Double-Check URL: Verify the URL and re-run the |
SQAI Connects, But Context is Poor | C. Token User Permissions: The user generating the token does not have permission to view certain projects or boards you are asking SQAI to analyze. | Check User Access: Ensure the user account associated with the token has view access to the specific Jira projects being referenced in your prompts. |
Token Expired | D. Token Expiration: Access Tokens are set to expire after a certain period. | Generate New Token: The original user must create a new API key/token with the required scopes and update the configuration in SQAI Suite. |