- Getting started
- Project management
- Documents
- Working with Change Impact Analysis
- Create test cases
- Assigning test cases to requirements
- Cloning test cases
- Exporting test cases
- Linking test cases in Studio to Test Manager
- Delete test cases
- Manual test cases
- Document test cases with Task Capture
- Parameters
- Enabling governance at project level
- Disabling governance at project level
- Enabling governance at test-case level
- Disabling governance at test-case level
- Managing approvers for governed test cases
- Managing governed test cases in the In Work state
- Managing governeed test cases in the In Review state
- Managing governed objects in the Signed state
- Managing comments for governed test cases
- Applying filters and views
- Importing Orchestrator test sets
- Creating test sets
- Adding test cases to a test set
- Assigning default users in test set execution
- Enabling activity coverage
- Enabling Healing Agent
- Configuring test sets for specific execution folders and robots
- Overriding parameters
- Cloning test sets
- Exporting test sets
- Applying filters and views
- Accessibility testing for Test Cloud
- Project operations and utilities
- Test Manager settings
- ALM tool integration
- API integration
- Integrating your tool with Test Manager
- API Scopes
- Coding Agents for Testing
- Troubleshooting
Integrate an external application with Test Manager by establishing a service-to-service connection using the available authorization methods.
The authorization methods described in this section provide information on how to establish a service-to-service connection between Test Manager and your application, or other partner applications.
Prerequisites
Enable Test Automation in Automation CloudTM.. For more information, see Enabling or disabling Services.
Adding the external tool to Automation CloudTM
To integrate your tool with Test Manager, you need to add it as an external application in Automation CloudTM.
Follow the Adding an external application procedure.
Provisioning through Identity Management
You can register your application in Identity Management, define the Test Manager scopes, and establish a connection between the applications.
To configure and authorize your application, you need to add an external application
When you define the API scopes for the integration, select Test Manager as a Resource. For more information, see Scopes.
Authenticating API calls
Test Manager APIs require an OAuth 2.0 access token — there is no separate API key authentication method. To obtain a bearer token:
- Register an external application in Automation CloudTM and select the Test Manager scopes. For steps, see Adding an external application.
- Note the AppId, Secret, and selected scopes for use in the next step.
- Request a token from the Identity
/connect/tokenendpoint using theclient_credentialsgrant type, passing the AppId, Secret, and scopes. - Include the returned bearer token in the
Authorizationheader of your Test Manager API calls.
In tools like Postman, select the OAuth 2.0 authorization type, not API Key — pasting the AppId and Secret directly as an API key results in a 401 Unauthorized error. Swagger cannot demonstrate this flow, since Swagger itself authenticates using it.
API examples
To perform an API call to Test Manager, you can look at the following example for fetching Test Manager projects.
For more API calls to Test Manager, use Swagger. To access your Automation CloudTM tenant in Swagger, check out the API references topic.
GET/api/v2/projects • GET/api/v2/projects/{id}