1. How does SQAI Suite Leverage This Integration?
Connecting to Azure DevOps (ADO) Test Plans allows SQAI to integrate directly into your testing workflow, transforming manual effort into automated tasks:
Contextual Test Case Generation: SQAI pulls existing requirements, user stories, and acceptance criteria from your ADO projects to generate precise, relevant test cases in your Test Plans.
Centralized Test Management: Newly generated test cases are pushed directly into your designated ADO Test Plan/Suite, ensuring a single source of truth for all testing assets.
Traceability: Maintains a clear link between the requirements (Tickets/User Stories) in ADO and the test cases created by SQAI.
Continuous Improvement: Allows SQAI to "learn" from your organization's established testing structure and conventions within ADO, improving future output quality.
2. Information Required from Your Azure DevOps Account
To establish a secure, plug-and-play connection, we need four specific pieces of information, most of which can be found directly in your ADO URL.
The required information is extracted from a URL structure like this:
https://dev.azure.com/{YOUR_ORGANIZATION}/{YOUR_PROJECT}/_testPlans/execute?planId={TEST_PLAN_ID}&suiteId={TEST_SUITE_ID}
ℹ️ Example URL:
https://dev.azure.com/sqaisuite/fooproj/_testPlans/execute?planId=4&suiteId=5
Required Detail | Explanation | Value in the Example |
Organization Name | The primary name of your DevOps organization. | sqaisuite |
Project Name | The specific project where the Test Plans reside. | fooproj |
Test Plan ID | The numerical ID of the Test Plan you want to target. | 4 |
Test Suite ID | The numerical ID of the specific Test Suite within the Test Plan. | 5 |
Personal Access Token (PAT) | The secure, custom access token generated by a user with the correct permissions (see Section 3). |
|
3. Setting up the integration
The most crucial step is generating a Personal Access Token (PAT) with the correct scope to ensure secure access.
🔑 Permission Requirements
The user generating the PAT must have the necessary licensing and permissions to interact with Test Plans:
❌ Note:
The user must have the Basic Access Level PLUS (+) the Test Plans extension license. The basic access level alone is NOT sufficient.
More Information: Refer to the official Microsoft documentation on licensing: https://learn.microsoft.com/en-us/azure/devops/test/manual-test-permissions?view=azure-devops#license-requirements
☑️ Step-by-step configuration
As already partially mentioned in section 2 and additionally on your SQAI Azure DevOps Test Plans Configuration Page you'll need the following details to succesfully connect SQAI Suite to ADO Test Plans:
Personal Access Token (mandatory): Also often referred to in SQAI as an API Key
Expiration Date (optional): When you set the expiration date of your API Key in the SQAI Configuration, SQAI will alert SQAI admins when the API key is about to expire so that it can be renewed.
Azure DevOps Base URL (optional): You only have to provide this in case you have a custom Azure DevOps instance URL. You may leave this empty if you use the default URL (https://dev.azure.com).
And then as mentioned in section 2 and all mandatory:
Organization
Project
Test plan id
Test suite id
Step 1: Retrieve your details:
⚠️ Quick Tip:
Apart from the access token, most of the remaining details can easily be found in the DevOps URL via your Internet Browser (see image below)
Once retrieved, you can go ahead and move on to the next step, getting the Personal Access Token.
Step 2 Get & Set Personal Access Token Scopes:
In Azure DevOps User Settings, go to Personal Access Tokens (see image below)
Create a new token, ensuring you set the "Test Management " and "Work Items" scopes to "Read & Write"
❌ Note:
Test Cases in ADO Test Plans are seen as Work Items by the API, hence we also need the "Read & Write" permissions on Work Items. SQAI will not be able to operate without those permissions. (see images below)
⚠️ Quick Tip:
For detailed steps on generating the PAT, please consult the Azure DevOps documentation: Use personal access tokens - Azure DevOps | Microsoft Learn
Step 3: Secure Token:
Immediately copy and secure the generated Personal Access Token (PAT).
Step 4: Enter your details in SQAI Suite:
Insert at least all mandatory extracted URL parameters (Org, Project, Plan ID, Suite ID) and the newly generated PAT in the SQAI ADO Test Plans Configuration Page.
Step 5: Save and Confirm the Configuration:
Click "Save Configruation" in SQAI
In case the set-up succeeded, you will get a success message:
A green dot will show next to your integration:
Congratulations, you have succesfully set-up Azure DevOps Test Plans in SQAI Suite!
4. Troubleshooting
❌ Note:
If SQAI Suite throws an error or fails to connect, use the checklist below to quickly identify and resolve the most common integration issues.
Problem | Cause | Solution |
Connection Failed: "Unauthorized" or "Access Denied" | Incorrect PAT Scope: The Personal Access Token (PAT) is missing the required Read & Write permissions for the Test or Work Items categories. | Verify PAT Scopes: Go to User Settings > Personal access tokens and confirm the active token includes both Test: Read & Write and Work Items: Read & Write permissions. |
"Access Denied" on Test Case Push | Missing License/Access Level: The user who generated the PAT only has "Basic" access level, but requires the Test Plans extension license. | Check User Licensing: A DevOps Administrator must confirm the PAT-generating user has the correct Basic + Test Plans license. Without the Test Plans extension, the API access will fail. |
Invalid Resource: Cannot Find Project/Plan | Incorrect ID/Name: The Organization Name, Project Name, Test Plan ID, or Test Suite ID contains a typo or is incorrect. | Double-Check URL: Copy the exact URL from the browser (e.g., |
SQAI simply does not connect | IP Restriction/Whitelisting: Your Azure DevOps instance could be secured by an additional organizational firewall or VPN, preventing external access. | Contact IT: If the instance is in a VPC, contact your IT team to whitelist a dedicated SQAI Suite IP address for inbound connections. (Contact the SQAI Team for a Static IP) |
PAT Expired | Token Expiration: PATs are set to expire after a certain period (e.g., 90 days or one year). | Generate New PAT: The PAT-generating user must create a new PAT with the same required scopes and provide it to the SQAI Admin (CSM or Alexander). |