⚠️ Warning: This integration is for Xray Test Management and Xray Enterprise within Jira Cloud. It is not for the separate Xray Exploratory Testing application.
1. How does SQAI Suite Leverage This Integration?
Connecting to Xray allows SQAI to integrate directly into your Jira/Xray testing management workflow:
Contextual Analysis: SQAI reads existing requirements and test case structures within Jira and Xray to inform generated output.
Test Case Generation & Linkage: Allows SQAI to generate new test cases and link them directly to Xray test types (e.g., Cucumber, Generic, Manual).
Execution Management: Enables SQAI to interact with Test Sets and Test Executions within Xray.
1.1 Complementary Value: SQAI Suite and Xray AI
Xray Test Management offers powerful AI capabilities focused on internal test model generation, coverage maximization, and execution pipeline triggering within the Jira ecosystem. SQAI Suite is highly complementary, specializing in multisource context aggregation and open ecosystem delivery.
Focus Area | Xray Contribution | SQAI Contribution |
Context & Generation | Internal Modeling: Uses AI Test Model Generation and Intelligent Augmentation algorithms to transform Jira requirements into visual models and find coverage gaps. | External Synthesis: Consumes the organized Jira/Xray context and synthesizes it with documentation from Confluence, SharePoint, Redmine, Notion, Azure Wiki, etc., to generate assets based on all available enterprise knowledge. |
Execution & Delivery | Test Management: Manages test case versions, compliance, dynamic test plans (JQL), and triggers CI/CD pipelines for execution. | Open Ecosystem: Delivers automation code (Playwright, Selenium) into external code repositories (GitHub, GitLab, Bitbucket), streamlining the customer's self-managed automation pipeline for execution by external tools (e.g., BrowserStack). |
By leveraging both platforms, customers gain the benefit of Xray's governance and execution control alongside SQAI's superior, context-driven generation and broad connectivity.
2. Information Required from Your Xray Account
Xray authentication is a two-step process requiring both a Jira-level token for standard user access and an Xray-specific Client ID/Secret for programmatic access.
Required Detail | Explanation | How to Find It |
Jira URL | The full URL of your Jira Cloud instance with the project key. |
|
Username | The email address of the user or service account for the API token. | Your Jira login email. |
API Token | A secure token generated in your Atlassian settings for user authentication. | See Section 3.1. |
Client ID | A unique identifier for the Xray API application. | See Section 3.2. |
Client Secret | The confidential key corresponding to the Client ID. | See Section 3.2. |
3. Setting up the Integration (Two-Part Authentication)
You must generate two distinct sets of credentials: the Atlassian API Token and the Xray Client ID/Secret.
3.1 Part A: Generate Jira API Token
This token authenticates the user account (or service account) within Jira.
Navigate to your Atlassian Account Settings. You can go straight to the token URL: Atlassian API Token URL
Click Create API Token
Provide a name (e.g., "SQAI Xray Integration") and click Create.
Copy the generated API Token immediately and store it securely
3.2 Part B: Generate Xray Client ID and Secret
This creates the specific credentials required by the Xray API endpoints.
In Jira, navigate to Jira Settings (Gear Icon) -> Apps (or access the Xray admin settings directly).
Locate Xray in the Apps sidebar and click App settings
In the Xray settings, navigate to the API Keys tab
Click Create API Key
Select the User or Service Account for which the key is being generated
Click Generate
Immediately copy and secure both the Client Id and the Client Secret
4. Entering Details in SQAI Suite
Once you have secured all five required credentials, 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 Xray configuration.
Step 2: Enter Details Insert the following details into the corresponding fields:
Configuration Field Name | Value to Enter | Notes |
Client ID | The Client ID from the Xray API Key generation (Section 3.2). | Identifies the Xray application. |
Client Secret | The Client Secret from the Xray API Key generation (Section 3.2). | The confidential key for the Xray API. |
API key | The Jira API Token generated in Section 3.1. | Used for general Jira user authentication. |
Expiration Date | Optional. Set the date your Jira API key expires. | Used by SQAI for reminder alerts. |
Base URL | The Jira Instance URL (e.g., | Excludes the |
Project Key | The Project Key (e.g., | The key used in Jira for the target project. |
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 integration.
5. Troubleshooting Xray Integration
If SQAI reports an error or fails to connect, use this checklist to quickly identify and resolve the most common issues related to the two-part authentication.
Problem | Cause | Solution |
Connection Failed: "Jira Unauthorized" | A. Invalid Jira API Token: The Atlassian API Token or Username (email) is incorrect. | Verify Jira Credentials: Check the Atlassian Account settings (Section 3.1) to ensure the API Token and associated Username are correct. |
Connection Fails: "Xray API Error" | B. Invalid Xray Credentials: The Client ID or Client Secret generated in Xray is incorrect. | Verify Xray Credentials: Check the Xray API Keys settings (Section 3.2) to ensure the Client ID and Secret were copied accurately. |
Invalid Resource: Cannot Find Project | C. Incorrect Project Key/URL: The URL or Project Key entered contains a typo. | Double-Check URL: Verify the full Jira URL, including the correct Project Key, as Xray access is project-scoped. |
Token Expired | D. Token Expiration: The Jira API Token is set to expire. | Generate New Token: Create a new Jira API Token (Section 3.1) and update the configuration in SQAI Suite. |