Permissions

The account accessing the API requires project/organisation level permissions to access each supported Method of a resource, the table below documents each resource and the permissions required for use.

Name	GET	PATCH	POST	PUT	DELETE
Agile Run	TestManagement / View	Unsupported	Unsupported	TestManagement / ExecuteTests	TestManagement / ManageExecution
Agile Run All Relationships	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Agile Run Relationships	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Agile Run Step Attachments	TestManagement / View	Unsupported	TestManagement / ExecuteTests	Unsupported	Unsupported
Agile Run Step Incident	TestManagement / View	Unsupported	Unsupported	Unsupported	TestManagement / ExecuteTests
Agile Run Step Incidents	TestManagement / View	Unsupported	TestManagement / ExecuteTests	Unsupported	Unsupported
Agile Run Step Result Attachment	Unsupported	Unsupported	Unsupported	Unsupported	TestManagement / ExecuteTests
Agile Runs	TestManagement / View	Unsupported	TestManagement / ExecuteTests	Unsupported	Unsupported
Assigned To Search	No Permissions	Unsupported	No Permissions	Unsupported	Unsupported
Attachment Contents	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Automated Test	TestManagement / View	Unsupported	Unsupported	TestManagement / ManageScripts	TestManagement / ManageScripts
Automated Test All Relationships	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Automated Test Assignment	TestManagement / View	Unsupported	Unsupported	TestManagement / ManageExecution	TestManagement / ManageExecution
Automated Test Assignment All Relationships	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Automated Test Assignment Relationships	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Automated Test Assignments	TestManagement / View	Unsupported	TestManagement / ManageExecution	Unsupported	Unsupported
Automated Test Relationships	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Automated Test Run	TestManagement / View	Unsupported	Unsupported	Unsupported	TestManagement / ManageExecution
Automated Test Run Attachment	Unsupported	Unsupported	Unsupported	Unsupported	TestManagement / ManageExecution
Automated Test Run Attachments	TestManagement / View	Unsupported	TestManagement / ManageExecution	Unsupported	Unsupported
Automated Test Run Data	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Automated Test Run Incident	TestManagement / View	Unsupported	Unsupported	Unsupported	TestManagement / ManageExecution
Automated Test Run Incidents	TestManagement / View	Unsupported	TestManagement / ManageExecution	Unsupported	Unsupported
Automated Test Run Node Attachment	Unsupported	Unsupported	Unsupported	Unsupported	TestManagement / ManageExecution
Automated Test Run Node Attachments	TestManagement / View	Unsupported	TestManagement / ManageExecution	Unsupported	Unsupported
Automated Test Run Result Children	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Automated Test Run Result Node	TestManagement / View	TestManagement / ExecuteTests	Unsupported	Unsupported	Unsupported
Automated Test Run Result Root Nodes	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Automated Test Runs	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Automated Tests	TestManagement / View	Unsupported	TestManagement / ManageScripts	Unsupported	Unsupported
Background Task	Enforced by task implementation	Unsupported	Unsupported	Unsupported	Unsupported
Background Tasks	Unsupported	Unsupported	Enforced by task implementation	Unsupported	Unsupported
Custom Field	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Custom Field Type	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Custom Field Types	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Custom Fields	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Execution Package	TestManagement / View	Unsupported	Unsupported	TestManagement / ManageExecution	TestManagement / ManageExecution
Execution Package Children	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Execution Packages	TestManagement / View	Unsupported	TestManagement / ManageExecution	Unsupported	Unsupported
Export File	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
External Source Metadata	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
External Sources Metadata	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
External System	Resources / ExternalLinks	Resources / ExternalLinks	Unsupported	Resources / ExternalLinks	Resources / ExternalLinks
External System Link	Resources / ExternalLinks	Resources / ExternalLinks	Unsupported	Unsupported	Resources / ExternalLinks
External System Link Copy	Unsupported	Unsupported	Resources / ExternalLinks	Unsupported	Unsupported
External System Link Field Values	Resources / ExternalLinks	Unsupported	Unsupported	Unsupported	Unsupported
External System Link Ticket	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
External System Link Ticket Link	Unsupported	Unsupported	TestManagement / ExecuteTests	Unsupported	Unsupported
External System Links	Resources / ExternalLinks	Unsupported	Resources / ExternalLinks	Unsupported	Unsupported
External System Links Search	TestManagement / View	Unsupported	TestManagement / View	Unsupported	Unsupported
External System Type	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
External System Types	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
External Systems	Resources / ExternalLinks	Unsupported	Resources / ExternalLinks	Unsupported	Unsupported
External System's Links	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Grid Widget Data	Unsupported	Unsupported	No Permissions	Unsupported	Unsupported
Grid Widget State	No Permissions	Unsupported	Unsupported	No Permissions	Unsupported
Grid Widget States	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Group	No Permissions	Unsupported	Unsupported	Administration / Organisation / ManageUserAndGroupSecurity	Administration / Organisation / ManageUserAndGroupSecurity
Group Permission Projects	Administration / Organisation / ManageUserAndGroupSecurity	Unsupported	Unsupported	Unsupported	Unsupported
Group Permissions	Administration / Organisation / ManageUserAndGroupSecurity	Unsupported	Unsupported	Administration / Organisation / ManageUserAndGroupSecurity	Unsupported
Group Users	No Permissions	Unsupported	Unsupported	No Permissions	Unsupported
Groups	No Permissions	Unsupported	Administration / Organisation / ManageUserAndGroupSecurity	Unsupported	Unsupported
Groups Search	TestManagement / View	Unsupported	TestManagement / View	Unsupported	Unsupported
Incident	TestManagement / View	Unsupported	Unsupported	TestManagement / ExecuteTests	TestManagement / ExecuteTests
Incident All Relationships	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Incident Attachment	Unsupported	Unsupported	Unsupported	Unsupported	TestManagement / ExecuteTests
Incident Attachments	TestManagement / View	Unsupported	TestManagement / ExecuteTests	Unsupported	Unsupported
Incident Comments	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Incident Relationships	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Incidents	TestManagement / View	Unsupported	TestManagement / ExecuteTests	Unsupported	Unsupported
Latest Performance Measurement	Administration / Organisation	Unsupported	Unsupported	Unsupported	Unsupported
Mail Queue Messages	Administration / Organisation	Unsupported	Unsupported	Unsupported	Unsupported
Mail Sender Settings	Administration / Organisation	Unsupported	Unsupported	Administration / Organisation	Unsupported
Notification	No Permissions	No Permissions	Unsupported	Unsupported	No Permissions
Notifications	No Permissions	Unsupported	Administration / Organisation	Unsupported	No Permissions
Organisation	No Permissions	Unsupported	Unsupported	Administration / Organisation / ManageOrganisation	Administration / Organisation / ManageOrganisation
Organisation Picklist	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Organisation Picklist Search	TestManagement / View	Unsupported	TestManagement / View	Unsupported	Unsupported
Organisation Relationship Types	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Organisations	No Permissions	Unsupported	Administration / Organisation / ManageOrganisation	Unsupported	Unsupported
Permission	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Permissions	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Project	TestManagement / View	Unsupported	Unsupported	Project / ManageProject	Project / ManageProject
Project Assignees	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Project Categories	No Permissions	Unsupported	Administration / Organisation / ManageOrganisation	Unsupported	Unsupported
Project Category	No Permissions	Unsupported	Unsupported	Administration / Organisation / ManageOrganisation	Administration / Organisation / ManageOrganisation
Project Category Children	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Project Group Permissions	Administration / Organisation / ManageUserAndGroupSecurity	Unsupported	Unsupported	Administration / Organisation / ManageUserAndGroupSecurity	Unsupported
Project Picklist	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Project Picklist Search	TestManagement / View	Unsupported	TestManagement / View	Unsupported	Unsupported
Project Templates	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Project Tickets	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Project User Permissions	Administration / Organisation / ManageUserAndGroupSecurity	Unsupported	Unsupported	Administration / Organisation / ManageUserAndGroupSecurity	Unsupported
Projects	TestManagement / View	Unsupported	Project / ManageProject	Unsupported	Unsupported
Projects Search	TestManagement / View	Unsupported	TestManagement / View	Unsupported	Unsupported
Relationship	TestManagement / View	Unsupported	Unsupported	TestManagement / View	TestManagement / View
Relationship Type	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Relationship Types	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Relationships	Unsupported	Unsupported	TestManagement / View	Unsupported	Unsupported
Requirement	TestManagement / View	Unsupported	Unsupported	TestManagement / ManageRequirements	TestManagement / ManageRequirements
Requirement All Relationships	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Requirement Attachment	Unsupported	Unsupported	Unsupported	Unsupported	TestManagement / ManageRequirements
Requirement Attachments	TestManagement / View	Unsupported	TestManagement / ManageRequirements	Unsupported	Unsupported
Requirement Children	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Requirement Comments	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Requirement Package	TestManagement / View	Unsupported	Unsupported	TestManagement / ManageRequirements	TestManagement / ManageRequirements
Requirement Package Children	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Requirement Packages	TestManagement / View	Unsupported	TestManagement / ManageRequirements	Unsupported	Unsupported
Requirement Relationships	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Requirements	TestManagement / View	Unsupported	TestManagement / ManageRequirements	Unsupported	Unsupported
Root	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Script	TestManagement / View	Unsupported	Unsupported	TestManagement / ManageScripts	TestManagement / ManageScripts
Script All Relationships	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Script Assignment	TestManagement / View	Unsupported	Unsupported	TestManagement / ManageExecution	TestManagement / ManageExecution
Script Assignment All Relationships	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Script Assignment Relationships	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Script Assignment Runs	TestManagement / View	Unsupported	TestManagement / ExecuteTests	Unsupported	Unsupported
Script Assignments	TestManagement / View	Unsupported	TestManagement / ManageExecution	Unsupported	Unsupported
Script Attachment	Unsupported	Unsupported	Unsupported	Unsupported	TestManagement / ExecuteTests
Script Attachments	TestManagement / View	Unsupported	TestManagement / ManageScripts	Unsupported	Unsupported
Script Package	TestManagement / View	Unsupported	Unsupported	TestManagement / ManageScripts	TestManagement / ManageScripts
Script Package Children	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Script Packages	TestManagement / View	Unsupported	TestManagement / ManageScripts	Unsupported	Unsupported
Script Relationships	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Script Run	TestManagement / View	Unsupported	Unsupported	TestManagement / ExecuteTests	TestManagement / ManageExecution
Script Runs	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Scripts	TestManagement / View	Unsupported	TestManagement / ManageScripts	Unsupported	Unsupported
Script's Assignments	TestManagement / View	Unsupported	TestManagement / ManageExecution	Unsupported	Unsupported
Search	TestManagement / View	Unsupported	TestManagement / View	Unsupported	Unsupported
Search Index	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Search Indexes	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Step Result	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Step Result Attachment	Unsupported	Unsupported	Unsupported	Unsupported	TestManagement / ExecuteTests
Step Result Attachments	TestManagement / View	Unsupported	TestManagement / ExecuteTests	Unsupported	Unsupported
Step Result Incident	TestManagement / View	Unsupported	Unsupported	Unsupported	TestManagement / ExecuteTests
Step Result Incidents	TestManagement / View	Unsupported	TestManagement / ExecuteTests	Unsupported	Unsupported
Swagger API	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Swagger API List	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Synchronizer Schedule	Resources / ExternalLinks	Resources / ExternalLinks	Unsupported	Resources / ExternalLinks	Resources / ExternalLinks
Synchronizer Schedule Run	Unsupported	Unsupported	Resources / ExternalLinks	Unsupported	Unsupported
Synchronizer Schedules	Resources / ExternalLinks	Unsupported	Resources / ExternalLinks	Unsupported	Unsupported
System Event	No Permissions	Unsupported	Unsupported	Unsupported	No Permissions
System Events	No Permissions	Unsupported	Administration	Unsupported	No Permissions
System Info	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Temporary Attachment Set	No Permissions	Unsupported	No Permissions	Unsupported	Unsupported
Temporary Attachment Set Attachment	Unsupported	Unsupported	Unsupported	Unsupported	No Permissions
Temporary Attachments Set	Unsupported	Unsupported	No Permissions	Unsupported	Unsupported
Test Automated Test Assignments	TestManagement / View	Unsupported	TestManagement / ManageExecution	Unsupported	Unsupported
Time Zone	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
User	No Permissions	Unsupported	Unsupported	Administration / Organisation / ManageUserAndGroupSecurity	Administration / Organisation / ManageUserAndGroupSecurity
User Groups	No Permissions	Unsupported	Unsupported	No Permissions	Unsupported
User Mail	Unsupported	Unsupported	Administration / Organisation	Unsupported	Unsupported
User Password	Unsupported	Unsupported	Unsupported	Administration / Organisation / ManageUserAndGroupSecurity	Unsupported
User Permission Projects	Administration / Organisation / ManageUserAndGroupSecurity	Unsupported	Unsupported	Unsupported	Unsupported
User Permissions	Administration / Organisation / ManageUserAndGroupSecurity	Unsupported	Unsupported	Administration / Organisation / ManageUserAndGroupSecurity	Unsupported
Users	No Permissions	Unsupported	Administration / Organisation / ManageUserAndGroupSecurity	Unsupported	Unsupported
Users Search	TestManagement / View	Unsupported	TestManagement / View	Unsupported	Unsupported
Widgets	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported

Child pages

API / Permissions

Permissions