Skip to main content

Jira Component

Interact with the Jira API.

Component key: atlassian-jira

Description#

Jira is a proprietary issue tracking product developed by Atlassian that allows bug tracking and agile project management. This component allows you to create, update, comment on, and delete issues in a Jira project.

Authorization Notes#

Basic Auth#

If you select Basic Auth, you will need to supply your Jira email and an API token to the credential. For information on generating an API token refer to the Atlassian docs

OAuth 2.0#

If you select OAuth 2.0, you need to enable it for your app using the developer console. For more information, follow the guide here When you create your Jira app be sure to enter Prismatic's OAuth callback URL - https://oauth2.prismatic.io/callback - as a Callback URL. Consult Jira to determine the proper OAuth Scopes to assign to the credential. A list of available scopes to choose from can be found here It is important to note the difference in the host URL when using OAuth 2.0. If you are using OAuth 2.0, you MUST format your url like the following: https://api.atlassian.com/ex/jira/{cloudId}/rest/api/2/project You can obtain a cloud id by sending an authenticated request to the following endpoint: https://api.atlassian.com/oauth/token/accessible-resources

Actions#

Add Comment#

Add a comment to an issue | key: addComment

InputKeyDefaultNotesExample

Comment

string
/ Required
commentProvide a string value for the comment.10000

Host URL

string
/ Required
hostProvide a string value for the URL of your Jira account.example.atlassian.net

Issue Id

string
/ Required
issueIdProvide a string value for the unique Id of the issueNMP-7

Version

string
/ Required
version2Provide a string version of Jira you are using2

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Create Issue#

Create an issue within a given project | key: createIssue

InputKeyDefaultNotesExample

Assignee Id

string
assigneeProvide an Id for the person being assigned the issue.6130f823036d9e006aba2525

Description

string
/ Required
descriptionProvide a string value for the description of the issue.This is an example summary.

Host URL

string
/ Required
hostProvide a string value for the URL of your Jira account.example.atlassian.net

Issue Type

string
/ Required
issueTypeProvide a string value for the type issue you would like to make

Project Id

string
/ Required
projectIdProvide a string value for the unique Id of the project10000

Reporter Id

string
reporterProvide an Id for the person that is reporting the issue6130f823036d9e006aba2525

Summary

string
/ Required
summaryProvide a string value for the summary of the issue.This is an example summary.

Version

string
/ Required
version2Provide a string version of Jira you are using2

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Delete Comment#

Delete a comment from an issue | key: deleteComment

InputKeyDefaultNotesExample

Comment Id

string
/ Required
commentIdProvide a number for the comment Id.1000

Host URL

string
/ Required
hostProvide a string value for the URL of your Jira account.example.atlassian.net

Issue Id

string
/ Required
issueIdProvide a string value for the unique Id of the issueNMP-7

Version

string
/ Required
version2Provide a string version of Jira you are using2

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Delete Issue#

Delete an issue by id | key: deleteIssue

InputKeyDefaultNotesExample

Host URL

string
/ Required
hostProvide a string value for the URL of your Jira account.example.atlassian.net

Issue Id

string
/ Required
issueIdProvide a string value for the unique Id of the issueNMP-7

Version

string
/ Required
version2Provide a string version of Jira you are using2

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Find Issue#

Get information and metadata about an issue by id | key: findIssue

InputKeyDefaultNotesExample

Host URL

string
/ Required
hostProvide a string value for the URL of your Jira account.example.atlassian.net

Issue Number

string
/ Required
issueNumberProvide a string value for the issue number.10000

Version

string
/ Required
version2Provide a string version of Jira you are using2

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Find User#

Get information and metadata about an user by id | key: findUser

InputKeyDefaultNotesExample

Account Id

string
/ Required
accountIdProvide a string value for the unique Id of the account10000

Expand

string
expandThe response may contain a list under the _expandable property; you can specify any of its values separated by commas.body, version, history

Host URL

string
/ Required
hostProvide a string value for the URL of your Jira account.example.atlassian.net

Version

string
/ Required
version2Provide a string version of Jira you are using2

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Get Comments#

Get all the comments on a given issue | key: getComments

InputKeyDefaultNotesExample

Host URL

string
/ Required
hostProvide a string value for the URL of your Jira account.example.atlassian.net

Issue Id

string
/ Required
issueIdProvide a string value for the unique Id of the issueNMP-7

Version

string
/ Required
version2Provide a string version of Jira you are using2

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


List Projects#

Retrieve a list of all projects | key: listProjects

InputKeyDefaultNotesExample

Host URL

string
/ Required
hostProvide a string value for the URL of your Jira account.example.atlassian.net

Version

string
/ Required
version2Provide a string version of Jira you are using2

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri


Update Issue#

Update an existing issue within a given project | key: updateIssue

InputKeyDefaultNotesExample

Assignee Id

string
assigneeProvide an Id for the person being assigned the issue.6130f823036d9e006aba2525

Description

string
/ Required
descriptionProvide a string value for the description of the issue.This is an example summary.

Host URL

string
/ Required
hostProvide a string value for the URL of your Jira account.example.atlassian.net

Issue Id

string
/ Required
issueIdProvide a string value for the unique Id of the issueNMP-7

Issue Type

string
/ Required
issueTypeProvide a string value for the type issue you would like to make

Project Id

string
/ Required
projectIdProvide a string value for the unique Id of the project10000

Reporter Id

string
reporterProvide an Id for the person that is reporting the issue6130f823036d9e006aba2525

Summary

string
/ Required
summaryProvide a string value for the summary of the issue.This is an example summary.

Version

string
/ Required
version2Provide a string version of Jira you are using2

Authorization#

Authorization is required for this action.
Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

OAuth 2.0 - Authorization Codeoauth2OAuth 2.0 authorization using the authorization code grant type

Client ID |  client_id

Client Secret |  client_secret

Scopes |  scopes

Authorization URL |  auth_uri

Access Token URL |  token_uri