UiPath Documentation
test-manager
2023.4
false
  • Getting started
    • Getting started
      • Integrating with Studio
      • Creating a project
    • Licensing Test Manager
  • Project management
    • Documents
    • Heatmap
      • Prerequisites
        • Step 1: Installing the UiPath SAP Add-On in your SAP system
        • Step 2: Configuring your SAP system
        • Step 3: Configuring UiPath Test Manager
          • RFC connection
          • CSV file connection
      • Working with Heatmap
    • Requirements
    • Test cases
      • Assigning test cases to requirements
      • Linking test cases in Studio to Test Manager
      • Unlinking automation
      • Delete test cases
      • Document test cases with Task Capture
      • Create test cases
      • Cloning test cases
      • Automate test cases
      • Manual test cases
    • Test sets
    • Executing Tests
    • Test Results
  • Project operations and utilities
    • Import project
    • Export project
    • Export data
    • Bulk operations
    • Reports
    • Migrating Test Manager artifacts to other delivery options
  • Test Manager settings
    • User and Group Access Management
    • Custom fields
    • Application settings
    • My notifications
      • Subscribing to events
      • Unsubscribing from events
    • Telemetry
  • ALM tool integration
    • ALM tool integration
    • Test Manager Connect
    • Out-of-the-box connectors
      • SAP Solution Manager Integration
        • Setup and configuration
          • Configuring user machine
          • Configuring SAP Solution Manager
          • Configuring system under test
          • SAP Solution Manager command line
        • Use case scenarios
      • Atlassian Jira
      • Xray for Jira
      • Azure DevOps
      • ServiceNow
      • Webhooks
      • Redmine Integration
  • API integration
    • Test Manager API integration
      • Integrating your tool with Test Manager
      • API Scopes
    • Test Manager API
      • API version
      • Test Manager URL
      • API references
UiPath logo, featuring letters U and I in white

Test Manager user guide

Last updated Nov 11, 2025

API Scopes

Overview

To configure your external application with Test Manager, you need to configure the API resource (scopes) to enable specific permissions.

Scopes

The following table lists the Test Manager permissions associated with each scope.

Scope

Description

TM.Requirements.Read

Requirements read access.

TM.Requirements

Requirements read and write access.

TM.Projects.Write

Projects write access.

TM.Projects.Read

Projects read access.

TM.Projects

Projects read and write access.

TM.Users.Write

Users write access.

TM.Users.Read

Users read access.

TM.Users.

Users read and write access.

TM.Defects.Write

Defects write access.

TM.Defects.Read

Defects read access.

TM.Defects.

Defects read and write access.

TM.CustomFieldValues.Write

Custom Field Values write access.

TM.CustomFieldValues.Read

Custom Field Values read access.

TM.CustomFieldValues

Custom Field Values read and write access.

TM.CustomFieldDefinitions.Write

Custom Field Definitions write access.

TM.CustomFieldDefinitions.Read

Custom Field Definitions read access.

TM.CustomFieldDefinitions

Custom Field Definitions read and write access.

TM.Attachments.Write

Attachments write access.

TM.Attachments.Read

Attachments read access.

TM.Attachments

Attachments read and write access.

TM.TestExecutions.Write

Test Executions write access.

TM.TestExecutions.Read

Test Executions read access.

TM.TestExecutions

Test Executions read and write access.

TM.TestSets.Write

Test Sets write access.

TM.TestSets.Read

Test Sets read access.

TM.TestSets

Test Sets read and write access.

TM.TestCases.Write

Test Cases write access.

TM.TestCases.Read

Test Cases read access.

TM.TestCases

Test Cases read and write access.

  • Overview
  • Scopes

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated