Atlassian Jira

the atlassian jira connector allows users to integrate and automate their jira workflows within the swimlane turbine platform, enhancing project management and issue tracking capabilities atlassian jira is a widely used platform for issue tracking and project management, offering robust features to organize, assign, and prioritize tasks the atlassian jira connector for swimlane turbine allows users to automate the creation, assignment, and updating of issues, enhancing collaboration and streamlining workflows by integrating jira's capabilities with swimlane's security automation, teams can manage incidents more efficiently, track changes seamlessly, and respond to security events with precision this connector empowers end users to extend their incident response capabilities and optimize their security operations with minimal manual intervention prerequisites to effectively utilize the atlassian jira connector for turbine, ensure you have the following prerequisites custom authentication with the following parameter url the base url of your jira instance (e g , https //your domain atlassian net https //your domain atlassian net ) http basic authentication using these parameters url the base url of your jira instance username your jira username api token a jira api token generated from your atlassian account http bearer authentication with the following parameter url the base url of your jira instance access token a bearer token to authenticate api requests capabilities the atlassian jira connector has the following capabilities add attachment add comment assign issue convert rich text to adf create issue delete attachment delete comment delete issue edit issue find users find users by query get all labels get all users default get attachment content get attachment metadata and so on additional information in the case of using the create issue action, please check the following urls for the issuetype id , project key id and other related inputs link to sample id for issue types https //confluence atlassian com/jirakb/finding the id for issue types 646186508 htmllink to project id for issue types https //confluence atlassian com/jirakb/how to get project id from the jira user interface 827341414 htmlconfiguring of atlassian jira oauth 2 0 https //confluence atlassian com/adminjiraserver/jira oauth 2 0 provider api 1115659070 html the swimlane team will provide a python script and instructions on how to use the script to generate the access token and refresh token using oauth2 0 configurations atlassian jira custom authentication atlassian jira custom authentication using access token or client credentials configuration parameters parameter description type required url a url to the target host string required access token the access token string optional client id the client id must correspond to the client id specified in the registered client table string optional client secret the client secret must correspond to the redirect uri specified in the registered client table string optional refresh token the refresh token string optional verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional http basic authentication authenticates using username and api token configuration parameters parameter description type required url a url to the target host string required username username string required password api token string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional http bearer authentication authenticates using bearer token configuration parameters parameter description type required url a url to the target host string required token the access token string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions add comment adds a comment to a specified jira issue using the unique issueidorkey endpoint url /rest/api/3/issue/{{issueidorkey}}/comment method post input argument name type required description path parameters issueidorkey string required parameters for the add comment action parameters expand string optional use expand to include additional information in the response this parameter accepts renderedbody, which returns the comment body rendered in html input example {"parameters" {"expand" "renderedbody"},"path parameters" {"issueidorkey" "sct 214"}} output parameter type description status code number http status code of the response reason string response reason phrase self string output field self id string unique identifier author object output field author author self string output field author self author accountid string unique identifier author emailaddress string output field author emailaddress author avatarurls object url endpoint for the request author avatarurls 48x48 string url endpoint for the request author avatarurls 24x24 string url endpoint for the request author avatarurls 16x16 string url endpoint for the request author avatarurls 32x32 string url endpoint for the request author displayname string name of the resource author active boolean output field author active author timezone string output field author timezone author accounttype string type of the resource body object request body data body type string request body data body version number request body data body content array request body data body content type string request body data body content content array request body data body content content type string request body data body content content text string request body data output example {"self" "string","id" "12345678 1234 1234 1234 123456789abc","author" {"self" "string","accountid" "string","emailaddress" "string","avatarurls" {"48x48" "string","24x24" "string","16x16" "string","32x32" "string"},"displayname" "example name","active"\ true,"timezone" "string","accounttype" "string"},"body" {"type" "string","version" 123,"content" \[{}]},"updateauthor" {"self" "string","accountid" "string","emailaddress" "string","avatarurls" {"48x48" "string","24x24" "string","16x16" "string","3 assign issue assigns a specified jira issue to a user, provided the user has the necessary permissions for the project endpoint url /rest/api/3/issue/{{issueidorkey}}/assignee method put input argument name type required description path parameters issueidorkey string required the id or key of the issue to assign accountid string optional the account id of the user to assign the issue to use 1 to unassign the issue max length is 128 name string optional the name of the user to assign the issue to key string optional the key of the user to assign the issue to input example {"json body" {"accountid" "5b10a2844c20165700ede21g"},"path parameters" {"issueidorkey" "proj 123"}} output parameter type description status code number http status code of the response reason string response reason phrase accountid string unique identifier displayname string name of the resource emailaddress string output field emailaddress active boolean output field active timezone string output field timezone accounttype string type of the resource avatarurls object url endpoint for the request avatarurls 16x16 string url endpoint for the request avatarurls 24x24 string url endpoint for the request avatarurls 32x32 string url endpoint for the request avatarurls 48x48 string url endpoint for the request output example {"accountid" "string","displayname" "example name","emailaddress" "string","active"\ true,"timezone" "string","accounttype" "string","avatarurls" {"16x16" "string","24x24" "string","32x32" "string","48x48" "string"}} add attachment adds an attachment to a specified jira issue using the issueidorkey, including necessary path parameters and headers endpoint url /rest/api/3/issue/{{issueidorkey}}/attachments method post input argument name type required description attachments array required attachment to add attachments file string optional parameter for add attachment attachments file name string optional name of the resource path parameters issueidorkey string required parameters for the add attachment action headers object required http headers for the request headers x atlassian token string required http headers for the request input example {"path parameters" {"issueidorkey" "sct 216"},"headers" {"x atlassian token" "no check"}} output parameter type description status code number http status code of the response reason string response reason phrase output example \[] delete attachment removes a specified attachment from a jira issue using the unique attachment id provided in path parameters endpoint url /rest/api/3/attachment/{{id}} method delete input argument name type required description path parameters id string required parameters for the delete attachment action headers object required http headers for the request headers x atlassian token string required http headers for the request input example {"path parameters" {"id" "64327"},"headers" {"x atlassian token" "no check"}} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text output example {"response text" "string"} convert rich text to adf converts rich text to atlassian document format (adf) for seamless integration with jira applications input argument name type required description rich text object optional parameter for convert rich text to adf rich text summary string optional parameter for convert rich text to adf input example {"rich text" {"summary" "\<p>this is a test \<br />\<strong>this is a test \<br />\</strong>\<em>this is a test \</em>\<strong>\<br />\</strong>\<span style=\\"color #f1c40f;\\">this is a test \<br />\</span>\</p>\n\<p>\<span style=\\"color #e03e2d;\\">this is a test \</span>\</p>"}} output parameter type description summary object output field summary summary version number output field summary version summary type string type of the resource summary content array response content summary content type string type of the resource summary content content array response content summary content content type string type of the resource summary content content text string response content summary content content marks array response content summary content content marks type string type of the resource summary content content marks attrs object response content title object output field title title version number output field title version title type string type of the resource title content array response content title content type string type of the resource title content content array response content title content content type string type of the resource title content content text string response content gen object output field gen gen version number output field gen version gen type string type of the resource gen content array response content gen content file name string name of the resource gen content file string response content output example {"summary" {"version" 1,"type" "doc","content" \[{},{}]},"title" {"version" 1,"type" "doc","content" \[{}]},"gen" {"version" 1,"type" "doc","content" \[]},"p1" {"version" 1,"type" "doc","content" \[{},{},{}]},"p2" {"version" 1,"type" "doc","content" \[{},{},{}]},"p3" {"version" 1,"type" "doc","content" \[{}]}} delete comment remove a specific comment from an issue in atlassian jira using the issue and comment ids endpoint url /rest/api/3/issue/{{issueidorkey}}/comment/{{id}} method delete input argument name type required description path parameters issueidorkey string required the id or key of the issue path parameters id string required the id of the comment input example {"path parameters" {"issueidorkey" "proj 123","id" 10001}} output parameter type description status code number http status code of the response reason string response reason phrase errormessages array response message errors object error message if any output example {"errormessages" \["string"],"errors" {}} delete issue deletes a specified jira issue using the issueidorkey; subtasks must be deleted prior if present endpoint url /rest/api/3/issue/{{issueidorkey}} method delete input argument name type required description path parameters issueidorkey string required the id or key of the issue to delete parameters deletesubtasks string optional whether the issue's subtasks are deleted when the issue is deleted input example {"parameters" {"deletesubtasks"\ false},"path parameters" {"issueidorkey" "proj 123"}} output parameter type description status code number http status code of the response reason string response reason phrase errormessages array response message errors object error message if any output example {"errormessages" \["string"],"errors" {}} find users retrieve a list of atlassian jira users matching the search term, with a maximum of 50 results endpoint url /rest/api/3/user/search method get input argument name type required description parameters query string optional a query string that is matched against user attributes (displayname, and emailaddress) to find relevant users the string can match the prefix of the attribute's value for example, query=john matches a user with a displayname of john smith and a user with an emailaddress of johnson\@example com mailto\ johnson\@example com required, unless username is specified parameters username string optional this parameter is no longer available and will be removed from the documentation soon use query instead parameters accountid string optional a query string that is matched exactly against user account id required, unless query is specified parameters property string optional a query string used to search properties property keys are specified by path, so properties which are not direct properties of the returned objects should not be matched for example, if value is returned by a property called something nested property, then the request should include something nested as the property if the property is an array, then the request should include something nested\[] as the property parameters maxresults number optional the maximum number of items to return per page parameters startat number optional the index of the first item to return in a page of results (page offset) input example {"parameters" {"query" "john","maxresults" 50,"startat" 0}} output parameter type description status code number http status code of the response reason string response reason phrase output example \[] find users by query retrieve a list of atlassian jira users matching the search query, with a maximum of 50 results endpoint url /rest/api/3/user/search/query method get input argument name type required description parameters query string required a query string that is matched against user attributes (displayname, and emailaddress) to find relevant users the string can match the prefix of the attribute's value for example, query=john matches a user with a displayname of john smith and a user with an emailaddress of johnson\@example com mailto\ johnson\@example com parameters maxresults number optional the maximum number of items to return per page parameters startat number optional the index of the first item to return in a page of results (page offset) input example {"parameters" {"query" "john","maxresults" 50,"startat" 0}} output parameter type description status code number http status code of the response reason string response reason phrase self string output field self maxresults number result of the operation startat number output field startat total number output field total islast boolean output field islast nextpage string output field nextpage values array value for the parameter values accountid string unique identifier values accounttype string type of the resource values active boolean value for the parameter values applicationroles object value for the parameter values applicationroles callback object value for the parameter values applicationroles items array value for the parameter values applicationroles max results number value for the parameter values applicationroles pagingcallback object value for the parameter values applicationroles size number value for the parameter values avatarurls object url endpoint for the request values avatarurls 16x16 string url endpoint for the request values avatarurls 24x24 string url endpoint for the request values avatarurls 32x32 string url endpoint for the request values avatarurls 48x48 string url endpoint for the request values displayname string name of the resource values emailaddress string value for the parameter output example {"self" "string","maxresults" 123,"startat" 123,"total" 123,"islast"\ true,"nextpage" "string","values" \[{"accountid" "string","accounttype" "string","active"\ true,"applicationroles" {},"avatarurls" {},"displayname" "example name","emailaddress" "string","expand" "string","groups" {},"key" "string","locale" "string","name" "example name","self" "string","timezone" "string"}]} get all users default retrieve a complete list of all users within atlassian jira, encompassing active, inactive, and deleted accounts endpoint url /rest/api/3/users method get input argument name type required description parameters startat number optional the index of the first item to return parameters maxresults number optional the maximum number of items to return input example {"parameters" {"startat" 0,"maxresults" 50}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"date" "thu, 09 jan 2025 10 07 44 gmt","content type" "application/json;charset=utf 8","server" "atlassianedge","timing allow origin" " ","x arequestid" "45c9fb52879c4b3eb540cd8c9fb94205","set cookie" "atlassian xsrf token=5b8d9da0169a025c9f394f0e4434c12aa4e646d5 lin; path=/; sames ","x aaccountid" "5d07f57ceec00a0bcb5eca63","cache control" "no cache, no store, no transform","vary" "accept encoding","content encoding" "gzip","x content type options" "nosn get attachment content retrieve metadata for an attachment in atlassian jira, including filename and content type, using the attachment's id endpoint url /rest/api/3/attachment/content/{{id}} method get input argument name type required description path parameters id string required the id of the attachment parameters redirect boolean optional whether to redirect to the attachment input example {"path parameters" {"id" 10001}} output parameter type description status code number http status code of the response reason string response reason phrase filename string name of the resource mimetype string type of the resource size number output field size output example {"filename" "example name","mimetype" "string","size" 123} get attachment metadata retrieves metadata for a specified attachment in atlassian jira using the attachment id endpoint url /rest/api/3/attachment/{{id}} method get input argument name type required description path parameters id string required the id of the attachment input example {"path parameters" {"id" 10001}} output parameter type description status code number http status code of the response reason string response reason phrase id string unique identifier self string output field self filename string name of the resource author object output field author author self string output field author self author accountid string unique identifier author accounttype string type of the resource author active boolean output field author active author avatarurls object url endpoint for the request author avatarurls 16x16 string url endpoint for the request author avatarurls 24x24 string url endpoint for the request author avatarurls 32x32 string url endpoint for the request author avatarurls 48x48 string url endpoint for the request author displayname string name of the resource author key string output field author key author name string name of the resource created string output field created size number output field size mimetype string type of the resource content string response content thumbnail string output field thumbnail output example {"id" "12345678 1234 1234 1234 123456789abc","self" "string","filename" "example name","author" {"self" "string","accountid" "string","accounttype" "string","active"\ true,"avatarurls" {"16x16" "string","24x24" "string","32x32" "string","48x48" "string"},"displayname" "example name","key" "string","name" "example name"},"created" "2024 01 01t00 00 00z","size" 123,"mimetype" "string","content" "string","thumbnail" "string"} get jira attachment settings retrieve atlassian jira's attachment configurations, including enablement status and maximum size limits endpoint url /rest/api/3/attachment/meta method get output parameter type description status code number http status code of the response reason string response reason phrase enabled boolean output field enabled uploadlimit number output field uploadlimit output example {"enabled"\ true,"uploadlimit" 123} get changelogs retrieve a paginated list of changelogs for a specified issue in atlassian jira, sorted by the date from oldest to newest endpoint url /rest/api/3/issue/{{issueidorkey}}/changelog method get input argument name type required description path parameters issueidorkey string required the id or key of the issue parameters startat number optional the index of the first item to return in a page of results (page offset) parameters maxresults number optional the maximum number of items to return per page input example {"parameters" {"startat" 0,"maxresults" 50},"path parameters" {"issueidorkey" "proj 123"}} output parameter type description status code number http status code of the response reason string response reason phrase startat number output field startat maxresults number result of the operation total number output field total islast boolean output field islast nextpage string output field nextpage self string output field self values array value for the parameter values id string unique identifier values author object value for the parameter values author self string value for the parameter values author accountid string unique identifier values author active boolean value for the parameter values author avatarurls object url endpoint for the request values author avatarurls 16x16 string url endpoint for the request values author avatarurls 24x24 string url endpoint for the request values author avatarurls 32x32 string url endpoint for the request values author avatarurls 48x48 string url endpoint for the request values author displayname string name of the resource values author emailaddress string value for the parameter values author timezone string value for the parameter values created string value for the parameter values items array value for the parameter values items field string value for the parameter output example {"startat" 123,"maxresults" 123,"total" 123,"islast"\ true,"nextpage" "string","self" "string","values" \[{"id" "12345678 1234 1234 1234 123456789abc","author" {},"created" "2024 01 01t00 00 00z","items" \[]}]} get comment retrieves a specific comment from an issue in atlassian jira using the issue id or key and the comment id endpoint url /rest/api/3/issue/{{issueidorkey}}/comment/{{id}} method get input argument name type required description path parameters issueidorkey string required the id or key of the issue path parameters id string required the id of the comment parameters expand string optional use expand to include additional information in the response this parameter accepts renderedbody, which returns the comment body rendered in html input example {"parameters" {"expand" "renderedbody"},"path parameters" {"issueidorkey" "proj 123","id" 10001}} output parameter type description status code number http status code of the response reason string response reason phrase self string output field self id string unique identifier author object output field author author self string output field author self author accountid string unique identifier author active boolean output field author active author displayname string name of the resource body object request body data body type string request body data body version number request body data body content array request body data body content type string request body data body content content array request body data body content content type string request body data body content content text string request body data created string output field created updated string output field updated updateauthor object output field updateauthor updateauthor self string output field updateauthor self updateauthor accountid string unique identifier updateauthor active boolean output field updateauthor active updateauthor displayname string name of the resource visibility object output field visibility output example {"self" "string","id" "12345678 1234 1234 1234 123456789abc","author" {"self" "string","accountid" "string","active"\ true,"displayname" "example name"},"body" {"type" "string","version" 123,"content" \[{}]},"created" "2024 01 01t00 00 00z","updated" "2024 01 01t00 00 00z","updateauthor" {"self" "string","accountid" "string","active"\ true,"displayname" "example name"},"visibility" {"identifier" "string","type" "string","value" "string"}} get comments retrieves all comments for a specified jira issue, with optional ordering by creation date endpoint url /rest/api/3/issue/{{issueidorkey}}/comment method get input argument name type required description path parameters issueidorkey string required the id or key of the issue parameters startat number optional the index of the first item to return in a page of results (page offset) parameters maxresults number optional the maximum number of items to return per page parameters orderby string optional order the results by a particular field parameters expand string optional use expand to include additional information in the response this parameter accepts renderedbody, which returns the comment body rendered in html input example {"parameters" {"startat" 0,"maxresults" 50,"orderby" "created","expand" "renderedbody"},"path parameters" {"issueidorkey" "proj 123"}} output parameter type description status code number http status code of the response reason string response reason phrase startat number output field startat maxresults number result of the operation total number output field total comments array output field comments comments self string output field comments self comments id string unique identifier comments author object output field comments author comments author self string output field comments author self comments author accountid string unique identifier comments author emailaddress string output field comments author emailaddress comments author avatarurls object url endpoint for the request comments author avatarurls 16x16 string url endpoint for the request comments author avatarurls 24x24 string url endpoint for the request comments author avatarurls 32x32 string url endpoint for the request comments author avatarurls 48x48 string url endpoint for the request comments author displayname string name of the resource comments author active boolean output field comments author active comments author timezone string output field comments author timezone comments author accounttype string type of the resource comments body object request body data comments body type string request body data comments body version number request body data comments body content array request body data output example {"startat" 123,"maxresults" 123,"total" 123,"comments" \[{"self" "string","id" "12345678 1234 1234 1234 123456789abc","author" {},"body" {},"updateauthor" {},"created" "2024 01 01t00 00 00z","updated" "2024 01 01t00 00 00z","jsdpublic"\ true}]} get comments by ids fetches a paginated list of comments from atlassian jira using specified comment ids, accessible anonymously if needed endpoint url /rest/api/3/comment/list method post input argument name type required description parameters expand string optional use expand to include additional information in the response this parameter accepts renderedbody, which returns the comment body rendered in html ids array optional the list of comment ids input example {"parameters" {"expand" "renderedbody"},"json body" {"ids" \[10001,10002,10003]}} output parameter type description status code number http status code of the response reason string response reason phrase startat number output field startat maxresults number result of the operation total number output field total islast boolean output field islast values array value for the parameter values self string value for the parameter values id string unique identifier values author object value for the parameter values author self string value for the parameter values author accountid string unique identifier values author active boolean value for the parameter values author displayname string name of the resource values body object request body data values body type string request body data values body version number request body data values body content array request body data values body content type string request body data values body content content array request body data values body content content type string request body data values body content content text string request body data values created string value for the parameter values updated string value for the parameter values updateauthor object value for the parameter output example {"startat" 123,"maxresults" 123,"total" 123,"islast"\ true,"values" \[{"self" "string","id" "12345678 1234 1234 1234 123456789abc","author" {},"body" {},"created" "2024 01 01t00 00 00z","updated" "2024 01 01t00 00 00z","updateauthor" {},"visibility" {}}]} get fields retrieves all system and custom issue fields available in atlassian jira endpoint url /rest/api/3/field method get output parameter type description status code number http status code of the response reason string response reason phrase output example \[] get all labels retrieve a paginated list of labels from atlassian jira for categorizing issues endpoint url /rest/api/3/label method get input argument name type required description parameters startat number optional the index of the first item to return in a page of results (page offset) parameters maxresults number optional the maximum number of items to return per page input example {"parameters" {"startat" 0,"maxresults" 50}} output parameter type description status code number http status code of the response reason string response reason phrase startat number output field startat maxresults number result of the operation total number output field total islast boolean output field islast values array value for the parameter output example {"startat" 123,"maxresults" 123,"total" 123,"islast"\ true,"values" \["string"]} get project retrieve detailed information for a specified project in atlassian jira using the projectidorkey parameter endpoint url /rest/api/3/project/{{projectidorkey}} method get input argument name type required description path parameters projectidorkey string required the project id or project key (case sensitive) parameters expand string optional use expand to include additional information in the response this parameter accepts a comma separated list expand options include description, issuetypes, lead, projectkeys, url, permissions input example {"parameters" {"expand" "description,lead,url","properties" "key,value"},"path parameters" {"projectidorkey" "proj"}} output parameter type description status code number http status code of the response reason string response reason phrase expand string output field expand self string output field self id string unique identifier key string output field key description string output field description lead object output field lead lead self string output field lead self lead accountid string unique identifier lead accounttype string type of the resource lead active boolean output field lead active lead avatarurls object url endpoint for the request lead avatarurls 16x16 string url endpoint for the request lead avatarurls 24x24 string url endpoint for the request lead avatarurls 32x32 string url endpoint for the request lead avatarurls 48x48 string url endpoint for the request lead displayname string name of the resource lead key string output field lead key lead name string name of the resource components array output field components components ari string output field components ari components assignee object output field components assignee components assignee self string output field components assignee self components assignee accountid string unique identifier output example {"expand" "string","self" "string","id" "12345678 1234 1234 1234 123456789abc","key" "string","description" "string","lead" {"self" "string","accountid" "string","accounttype" "string","active"\ true,"avatarurls" {"16x16" "string","24x24" "string","32x32" "string","48x48" "string"},"displayname" "example name","key" "string","name" "example name"},"components" \[{"ari" "string","assignee" {},"assigneetype" "string","description" "string","id" "12345678 1234 1234 1234 123456789abc","isassigneetypev get available transitions retrieve all possible transitions for a jira issue, filtered by user permissions and current status, using the issueidorkey endpoint url /rest/api/3/issue/transitions method get input argument name type required description parameters issueidorkey string required the id or key of the issue parameters endingbefore string optional (optional) the end cursor for use in pagination parameters startingafter string optional (optional) the start cursor for use in pagination input example {"parameters" {"issueidorkey" "proj 123"}} output parameter type description status code number http status code of the response reason string response reason phrase availabletransitions array output field availabletransitions availabletransitions istransitionsfiltered boolean output field availabletransitions istransitionsfiltered availabletransitions issues array output field availabletransitions issues availabletransitions transitions array output field availabletransitions transitions availabletransitions transitions to object output field availabletransitions transitions to availabletransitions transitions to statusid number unique identifier availabletransitions transitions to statusname string name of the resource availabletransitions transitions transitionid number unique identifier availabletransitions transitions transitionname string name of the resource output example {"availabletransitions" \[{"istransitionsfiltered"\ true,"issues" \[],"transitions" \[]}]} get user retrieves a user's details from atlassian jira using the provided accountid, respecting privacy settings endpoint url /rest/api/3/user method get input argument name type required description parameters accountid string required the account id of the user, which uniquely identifies the user across all atlassian products max length is 128 parameters expand string optional use expand to include additional information about users in the response this parameter accepts a comma separated list expand options include groups includes all groups and nested groups to which the user belongs applicationroles includes details of all the applications to which the user has access input example {"parameters" {"accountid" "5b10ac8d82e05b22cc7d4ef5","expand" "groups"}} output parameter type description status code number http status code of the response reason string response reason phrase self string output field self accountid string unique identifier accounttype string type of the resource emailaddress string output field emailaddress avatarurls object url endpoint for the request avatarurls 48x48 string url endpoint for the request avatarurls 24x24 string url endpoint for the request avatarurls 16x16 string url endpoint for the request avatarurls 32x32 string url endpoint for the request displayname string name of the resource active boolean output field active timezone string output field timezone locale string output field locale groups object output field groups groups size number output field groups size groups items array output field groups items groups items file name string name of the resource groups items file string output field groups items file applicationroles object output field applicationroles applicationroles size number output field applicationroles size applicationroles items array output field applicationroles items applicationroles items file name string name of the resource applicationroles items file string output field applicationroles items file output example {"status code" 200,"response headers" {"date" "thu, 09 jan 2025 09 22 15 gmt","content type" "application/json;charset=utf 8","server" "atlassianedge","timing allow origin" " ","x arequestid" "3755c266a371a3de6f4ac4e217c9c2cf","set cookie" "atlassian xsrf token=180eb947a40a03f89fc1aa377d3d0be76190e334 lin; path=/; sames ","x aaccountid" "5d07f57ceec00a0bcb5eca63","cache control" "no cache, no store, no transform","vary" "accept encoding","content encoding" "gzip","x content type options" "nosn create issue creates a new issue or subtask in atlassian jira with the specified 'fields' from the json body input endpoint url /rest/api/3/issue method post input argument name type required description fields object optional parameter for create issue fields summary string required parameter for create issue fields parent object optional parameter for create issue fields parent key string optional parameter for create issue fields issuetype object required type of the resource fields issuetype id string required unique identifier fields components array optional parameter for create issue fields components id string optional unique identifier fields project object required parameter for create issue fields project id string optional unique identifier fields project key string optional parameter for create issue fields description object optional parameter for create issue fields description type string optional type of the resource fields description version number optional parameter for create issue fields description content array optional response content fields description content type string optional type of the resource fields description content content array optional response content fields description content content text string optional response content fields description content content type string optional type of the resource fields reporter object optional parameter for create issue fields reporter id string optional unique identifier fields fixversions array optional parameter for create issue fields fixversions id string optional unique identifier fields priority object optional parameter for create issue fields priority id string optional unique identifier input example {"json body" {"fields" {"summary" "issue summary","parent" {"key" "sct 214"},"issuetype" {"id" "10000"},"components" \[{"id" "10000"}],"project" {"id" "11435"},"description" {"type" "doc","version" 1,"content" \[{"type" "paragraph","content" \[{"text" "order entry fails when selecting supplier ","type" "text"}]}]},"reporter" {"id" "5b10a2844c20165700ede21g"},"fixversions" \[{"id" "10001"}],"priority" {"id" "20000"},"labels" \["bugfix","blitz test"],"timetracking" {"remainingestimate" "5","originalestimate" "10"},"security" {"id" "10000"},"environment" {"type" "doc","version" 1,"content" \[{"type" "paragraph","content" \[{"text" "uat","type" "text"}]}]},"versions" \[{"id" "10000"}],"duedate" "2019 05 11","assignee" {"id" "5b109f2e9729b51b54dc274d"}}}} output parameter type description status code number http status code of the response reason string response reason phrase id string unique identifier key string output field key self string output field self output example {"id" "12345678 1234 1234 1234 123456789abc","key" "string","self" "string"} edit issue modify an existing issue in atlassian jira using the issue id or key along with update details provided in the json body endpoint url /rest/api/3/issue/{{issueidorkey}} method put input argument name type required description path parameters issueidorkey string required parameters for the edit issue action historymetadata object optional response data historymetadata actor object optional response data historymetadata actor avatarurl string optional response data historymetadata actor displayname string optional response data historymetadata actor id string optional response data historymetadata actor type string optional response data historymetadata actor url string optional response data historymetadata extradata object optional response data historymetadata extradata iteration string optional response data historymetadata extradata step string optional response data historymetadata description string optional response data historymetadata generator object optional response data historymetadata generator id string optional response data historymetadata generator type string optional response data historymetadata cause object optional response data historymetadata cause id string optional response data historymetadata cause type string optional response data historymetadata activitydescription string optional response data historymetadata type string optional response data update object optional date value update summary array optional parameter for edit issue update summary set string optional parameter for edit issue update components array optional parameter for edit issue update components set string optional parameter for edit issue input example {"json body" {"historymetadata" {"actor" {"avatarurl" "http //mysystem/avatar/tony jpg","displayname" "tony","id" "tony","type" "mysystem user","url" "http //mysystem/users/tony"},"extradata" {"iteration" "10a","step" "4"},"description" "from the order testing process","generator" {"id" "mysystem 1","type" "mysystem application"},"cause" {"id" "myevent","type" "mysystem event"},"activitydescription" "complete order processing","type" "myplugin\ type"},"update" {"summary" \[{"set" "bug in business logic"}],"components" \[{"set" ""}],"timetracking" \[{"edit" {"remainingestimate" "4d","originalestimate" "1w 1d"}}],"labels" \[{"add" "triaged"},{"remove" "blocker"}]},"fields" {"summary" "completed orders still displaying in pending","customfield 10010" 1,"customfield 10000" {"type" "doc","version" 1,"content" \[{"type" "paragraph","content" \[{"text" "investigation underway","type" "text"}]}]}},"properties" \[{"value" "order number 10784","key" "key1"},{"value" "order number 10923","key" "key2"}]},"path parameters" {"issueidorkey" "sct 216"}} output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text output example {"response text" "string"} get issue retrieve detailed information for a specific issue in atlassian jira using the provided issue id or key endpoint url /rest/api/3/issue/{{issueidorkey}} method get input argument name type required description path parameters issueidorkey string required parameters for the get issue action input example {"path parameters" {"issueidorkey" "sc 5427"}} output parameter type description status code number http status code of the response reason string response reason phrase expand string output field expand id string unique identifier self string output field self key string output field key fields object output field fields fields parent object output field fields parent fields parent id string unique identifier fields parent key string output field fields parent key fields parent self string output field fields parent self fields parent fields object output field fields parent fields fields parent fields summary string output field fields parent fields summary fields parent fields status object status value fields parent fields status self string status value fields parent fields status description string status value fields parent fields status iconurl string url endpoint for the request fields parent fields status name string name of the resource fields parent fields status id string unique identifier fields parent fields status statuscategory object status value fields parent fields priority object output field fields parent fields priority fields parent fields priority self string output field fields parent fields priority self fields parent fields priority iconurl string url endpoint for the request fields parent fields priority name string name of the resource fields parent fields priority id string unique identifier output example {"expand" "string","id" "12345678 1234 1234 1234 123456789abc","self" "string","key" "string","fields" {"parent" {"id" "12345678 1234 1234 1234 123456789abc","key" "string","self" "string","fields" {}},"resolution" {},"lastviewed" {},"labels" \[{}],"aggregatetimeoriginalestimate" {},"issuelinks" \[{}],"assignee" {"self" "string","accountid" "string","emailaddress" "string","avatarurls" {},"displayname" "example name","active"\ true,"timezone" "string","accounttype" "string"},"subtasks" \[{}],"report search executes a jql based search for issues in atlassian jira using specified criteria and returns matching results endpoint url /rest/api/3/search/jql method post input argument name type required description expand string optional to include additional information about issues in the response note that, unlike the majority of instances where expand is specified, expand is defined as a comma delimited string of values fields array optional a list of fields to return for each issue use it to retrieve a subset of fields this parameter accepts a comma separated list fieldsbykeys boolean optional reference fields by their key (rather than id) jql string optional for performance reasons, this parameter requires a bounded query a bounded query is a query with a search restriction maxresults number optional the maximum number of items to return per page to manage page size, api may return fewer items per page where a large number of fields are requested the greatest number of items returned per page is achieved when requesting id or key only it returns max 5000 issues nextpagetoken string optional the token for a page to fetch that is not the first page the first page has a nextpagetoken of null use the nextpagetoken to fetch the next page of issues properties array optional a list of up to 5 issue properties to include in the results this parameter accepts a comma separated list reconcileissues array optional strong consistency issue ids to be reconciled with search results accepts max 50 ids input example {"json body" {"expand" "names","fields" \["id"],"fieldsbykeys"\ true,"jql" "assignee = currentuser() order by key","maxresults" 273,"nextpagetoken" "testing","properties" \["property 1"],"reconcileissues" \[2154]}} output parameter type description status code number http status code of the response reason string response reason phrase islast boolean output field islast issues array output field issues issues expand string output field issues expand issues fields object output field issues fields issues fields watcher object output field issues fields watcher issues fields watcher iswatching boolean output field issues fields watcher iswatching issues fields watcher self string output field issues fields watcher self issues fields watcher watchcount number count value issues fields attachment array output field issues fields attachment issues fields attachment author object output field issues fields attachment author issues fields attachment author accountid string unique identifier issues fields attachment author accounttype string type of the resource issues fields attachment author active boolean output field issues fields attachment author active issues fields attachment author avatarurls object url endpoint for the request issues fields attachment author displayname string name of the resource issues fields attachment author key string output field issues fields attachment author key issues fields attachment author name string name of the resource issues fields attachment author self string output field issues fields attachment author self issues fields attachment content string response content issues fields attachment created string output field issues fields attachment created issues fields attachment filename string name of the resource issues fields attachment id number unique identifier issues fields attachment mimetype string type of the resource output example {"islast"\ true,"issues" \[{"expand" "string","fields" {},"id" "12345678 1234 1234 1234 123456789abc","key" "string","self" "string"}]} add comment adds or updates a comment on a specified atlassian jira issue using the unique issueidorkey and comment id endpoint url /rest/api/3/issue/{{issueidorkey}}/comment/{{id}} method put input argument name type required description path parameters issueidorkey string required the id or key of the issue path parameters id string required the id of the comment parameters notifyusers boolean optional whether users are notified when a comment is updated parameters overrideeditableflag boolean optional whether screen security is overridden to enable uneditable fields to be edited available to connect app users with the administer jira global permission and forge apps acting on behalf of users with administer jira global permission parameters expand string optional use expand to include additional information about comments in the response this parameter accepts renderedbody, which returns the comment body rendered in html visibility object optional the group or role to which this comment is visible optional on create and update visibility identifier string optional the id of the group or the name of the role that visibility of this item is restricted to visibility type string optional whether visibility of this item is restricted to a group or role visibility value string optional the name of the group or role that visibility of this item is restricted to please note that the name of a group is mutable, to reliably identify a group use identifier body object optional the comment text in atlassian document format body type string optional request body data body version number optional request body data body content array required request body data body content type string optional request body data body content content array optional request body data body content content type string optional request body data body content content text string optional request body data properties array optional a list of comment properties optional on create and update properties key string optional the key of the property required on create and update properties value string optional the value of the property required on create and update input example {"parameters" {"notifyusers"\ true,"overrideeditableflag"\ false,"expand" "renderedbody"},"json body" {"visibility" {"identifier" "administrators","type" "role","value" "administrators"},"body" {"type" "doc","version" 1,"content" \[{"type" "paragraph","content" \[{"type" "text","text" "updated comment content"}]}]},"properties" \[{"key" "comment property key","value" "property value"}]},"path parameters" {"issueidorkey" "proj 123","id" 10001}} output parameter type description status code number http status code of the response reason string response reason phrase self string output field self id string unique identifier author object output field author author self string output field author self author accountid string unique identifier author active boolean output field author active author displayname string name of the resource body object request body data body type string request body data body version number request body data body content array request body data body content type string request body data body content content array request body data body content content type string request body data body content content text string request body data created string output field created updated string output field updated updateauthor object output field updateauthor updateauthor self string output field updateauthor self updateauthor accountid string unique identifier updateauthor active boolean output field updateauthor active updateauthor displayname string name of the resource visibility object output field visibility output example {"self" "string","id" "12345678 1234 1234 1234 123456789abc","author" {"self" "string","accountid" "string","active"\ true,"displayname" "example name"},"body" {"type" "string","version" 123,"content" \[{}]},"created" "2024 01 01t00 00 00z","updated" "2024 01 01t00 00 00z","updateauthor" {"self" "string","accountid" "string","active"\ true,"displayname" "example name"},"visibility" {"identifier" "string","type" "string","value" "string"}} response headers header description example atl request id http response header atl request id d99ae7c1 56c8 4ec3 be94 36847ece934f atl traceid http response header atl traceid c73756dd55fa4fafad7cd6518aacfb80 beta retry after http response header beta retry after 1 cache control directives for caching mechanisms no cache, no store, no transform connection http response header connection keep alive content encoding http response header content encoding gzip content type the media type of the resource application/json date the date and time at which the message was originated mon, 08 sep 2025 10 41 19 gmt expect ct http response header expect ct location the url to redirect a page to nel http response header nel {"failure fraction" 0 001, "include subdomains" true, "max age" 600, "report to" "endpoint 1"} report to http response header report to {"endpoints" \[{"url" " https //dz8aopenkvv6s cloudfront net https //dz8aopenkvv6s cloudfront net "}], "group" "endpoint 1", "include subdomains" true, "max age" 600} server information about the software used by the origin server atlassianedge server timing http response header server timing atl edge;dur=348,atl edge internal;dur=15,atl edge upstream;dur=335,atl edge pop;desc="aws ap south 1" set cookie http response header set cookie atlassian xsrf token=180eb947a40a03f89fc1aa377d3d0be76190e334 lin; path=/; samesite=none; secure strict transport security http response header strict transport security max age=63072000; includesubdomains; preload timing allow origin http response header timing allow origin transfer encoding http response header transfer encoding chunked vary http response header vary accept encoding via http response header via 1 1 0298f468fb8a5be020d6f3e7ff839738 cloudfront net (cloudfront) x aaccountid http response header x aaccountid 5d07f57ceec00a0bcb5eca63 x amz cf id http response header x amz cf id zklyd pa7of c1e8kspsszlzxefilykb0hwus4dcqcas v5wrpxza== x amz cf pop http response header x amz cf pop bom78 p1 x arequestid http response header x arequestid 9cee465f51193f09c0fceae8f2c2a1d6 x beta ratelimit limit http response header x beta ratelimit limit 200 x beta ratelimit reason http response header x beta ratelimit reason jira burst based x beta ratelimit remaining http response header x beta ratelimit remaining 199 x beta ratelimit reset http response header x beta ratelimit reset 2025 09 08t10 41z x cache http response header x cache miss from cloudfront x content type options http response header x content type options nosniff x xss protection http response header x xss protection 1; mode=block