Skip to main content

Cyware Orchestrate

Jira Software Platform

App Vendor: Atlassian

App Category: Case/Ticket Management

Connector Version: 1.0.0

API Version: 8.12.0

About App

Jira Software Platform is an agile project management tool. The Jira Software Platform app enables security teams to integrate with the Jira Software Platform enterprise application to manage issues in agile projects.

The Jira Software Platform app is configured with the Orchestrate application to perform the following actions:

Action Name

Description

Create Issue

This action creates an issue.

Get My Permissions

This action retrieves the permission details of the current user.

Get List of Projects

This action retrieves a list of projects.

Get Details of User

This action retrieves the details of a user.

Update Issue

This action updates an issue.

Add a Comment

This action adds a comment in an issue.

Get a List of Comments

This action retrieves a list of comments from an issue.

Get a List of Permissions

This action retrieves a list of all platform permissions.

Get a List of Users

This action retrieves a list of users.

Get Details of an Attachment

This action retrieves the details of an attachment.

Get Details of an Issue

This action retrieves the details of an issue.

Get Details of a Project

This action retrieves the details of a project.

JQL Query Search

This action retrieves the results of a JQL query search.

Get Details of a Comment

This action retrieves the details of a comment in an issue.

Add an Attachment

This action adds an attachment in an issue.

Configuration Parameters

The following configuration parameters are required for the Jira Software Platform app to communicate with the Jira Software Platform enterprise application. The parameters can be configured by creating instances in the app.

Parameter

Description

Field Type

Required/Optional

Comments

Base URL

Enter the Jira Software Platform base URL.

Example:

"http[s]://jira-server-platform-fqdn[:port]"

Text

Required

Username

Enter the username.

Text

Required

Password

Enter the password.

Password

Required

SSL Verification

Optional preference to either verify or skip the SSL certificate verification.

Example:

"True"

Boolean

Optional

Allowed values:

  • True

  • False

Default value: "False"

Action: Create Issue

This action creates an issue.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Project Key

Enter the project key to create an issue in the project.

Example:

"CDPROJ"

Text

Required

Issue Name

Enter the name or summary of the issue.

Example:

"New Issue over API"

Text

Required

Issue Description

Enter the issue description.

Example:

"New Issue over API"

Text

Required

Assignee Name

Enter the username of the user to assign the issue.

Example:

"admin"

Text

Required

Default value: None

Issue Type

Enter the issue type.

Example:

"Task"

Text

Optional

Allowed values:

  • bug

  • improvement

  • task

  • new feature

  • epic

  • sub task

Default value: bug

Additional Fields

Enter the additional fields in key-value pairs.

Key Value

Optional

Example Request 

[
  {
    "issue_type": "Task",
    "project_key": "CDPROJ",
    "extra_fields": {},
    "assignee_name": "admin",
    "issue_summary": "New Issue over API",
    "issue_description": "New Issue over API"
  }
]
Action: Get My Permissions

This action retrieves the permission details of the current user.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Additional Query Params

Enter the additional query parameters in key-value pairs.

Example:

{"issueid": "sample id" }

Key Value

Optional

Allowed values:

  • projectkey (str)

  • projectid (str)

  • issuekey (str)

  • issueid (str)

Example Request 

[
  {
    "query_params": {
                "issueid": "sample id"
        }
  }
]
Action: Get List of Projects

This action retrieves a list of projects.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Additional Query Params

Enter the additional query parameters in key-value pairs.

Example:

{ "browsearchive": true }

Key Value

Optional

Allowed values:

  • expand (str): the parameter to expand

  • recent (int): recent accessed by users (max 20)

  • includearchived (bool): default false

  • browsearchive (bool): default false

Example Request 

[
  {
    "query_params": {
                "browsearchive": true
        }
  }
]
Action: Get Details of User

This action retrieves the details of a user.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Username

Enter the username.

Example:

"admin"

Text

Required

Including Deleted User

Optional preference to either retrieve the details of a deleted user or skip deleted users.

Example:

false

Boolean

Optional

Default value: false

Example Request 

[
  {
    "user_name": "admin",
    "include_deleted": false
  }
]
Action: Update Issue

This action updates an issue.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Issue ID or Key

Enter the issue ID or key.

Example:

"CDPROJ-9"

Text

Required

Update Parameters

Enter the update parameters in JSON dictionary object format.

Example:

{ "summary": "issue summary updated over api", "description": "issue description updated over api" }

Key Value

Required

Example Request 

[
  {
    "params": {
      "summary": "issue summary updated over api",
      "description": "issue description updated over api"
    },
    "issue_id": "CDPROJ-9"
  }
]
Action: Add a Comment

This action adds a comment in an issue.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Issue ID/Key

Enter the issue ID or key.

Example:

"CDPROJ-9"

Text

Required

Comment

Enter the comment to add in the issue.

Example:

"New Comment over API"

Text

Required

Additional Query Parameters

Enter the additional query parameters in key-value pairs.

Key Value

Optional

Allowed values:

  • expand (str): "expanding response"

  • "flags": "renderedbody"

Example Request 

[
  {
    "comment": "New Comment over API",
    "issue_id": "CDPROJ-9",
    "query_params": {}
  }
]
Action: Get a List of Comments

This action retrieves a list of comments from an issue.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Issue ID/Key

Enter the issue ID or key.

Example:

"CDPROJ-9"

Text

Required

Additional Query Parameters

Enter the additional query parameters.

Key Value

Optional

Allowed values:

  • startat (int): Default value: 0

  • maxresults (int):

    • Default value: 50

    • Maximum allowed value: 1000

  • orderby (str)

  • expand (str): "expanding response", "flags": "renderedbody"

Example Request 

[
  {
    "issue_id": "CDPROJ-9",
    "query_params": {}
  }
]
Action: Get a List of Permissions

This action retrieves a list of all platform permissions.

Action Input Parameters

This action does not require any input parameter.

Action: Get a List of Users

This action retrieves a list of users.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Additional Query Parameters

Enter the additional query parameters in key-value pairs.

Example:

{"includeinactive": true }

Key Value

Optional

Allowed values:

  • username (str): username, name or email address

  • startat (int): Default value: 0

  • maxresults (int):

    • Default value: 50

    • Maximum value: 1000

  • includeactive (bool): Default value: true

  • includeinactive (bool): Default value: false

Example Request 

[
  {
    "query_params": {
                "includeinactive": true
        }
  }
]
Action: Get Details of an Attachment

This action retrieves the details of an attachment.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Attachment ID

Enter the attachment ID.

Example:

"10000"

Text

Required

Example Request 

[
  {
    "attachment_id": "10000"
  }
]
Action: Get Details of an Issue

This action retrieves the details of an issue.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Issue ID or Key

Enter the issue ID or key.

Example:

"CDPROJ-9"

Text

Required

Additional Query Parameters

Enter the additional query parameters in key-value pairs.

Example:

{ "updatehistory": true }

Key Value

Optional

Allowed values:

  • fields (str): Returns list of the selected fields. By default all fields are returned.

  • expand (str)

  • properties (str): Returns list of the selected properties. By default all properties are returned.

  • updatehistory (bool)

Example Request 

[
  {
    "issue_id": "CDPROJ-9",
    "query_params": {
                "updatehistory": true
        }
  }
]
Action: Get Details of a Project

This action retrieves the details of a project.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Project ID or Key

Enter the project ID or key.

Example:

"CDPROJ"

Text

Required

Example Request 

[
  {
    "project_id": "CDPROJ"
  }
]
Action: JQL Query Search

This action retrieves the results of a JQL query search.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

JQL Query String

Enter the JQL query string.

Example:

"project = projektcd"

Text

Required

Additional Query Parameters

Enter the additional query parameters in key-value pairs.

Example:

{"maxresults": 100 }

Key Value

Optional

Allowed values:

  • startat (int): Default value: 0

  • maxresults (int): Default value: 50

  • fields (str): Returns the selected fields. By default all fields are returned.

  • expand (str): Comma-separated list of parameters to expand.

JQL Query Validation

Optional preference to either validate or skip validating the JQL query.

Example:

true

Boolean

Optional

Allowed values:

  • true

  • false

Default value: true

Example Request 

[
  {
    "jql": "project = projektcd",
    "validate_query": true
    "extra_params": {
                "maxresults": 100
        }
  }
]
Action: Get Details of a Comment

This action retrieves the details of a comment in an issue.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Issue ID/Key

Enter the issue ID/Key.

Example:

"CDPROJ-9"

Text

Required

Comment ID

Enter the comment ID.

Example:

"10020"

Text

Required

Additional query parameters

Enter the additional query parameters in key-value pairs.

allowed values: "expand": "expanding response", "flags": "renderedbody"

Key Value

Optional

Allowed values:

Example Request 

[
  {
    "issue_id": "CDPROJ-9",
    "comment_id": "10020",
    "query_params": {}
  }
]
Action: Add an Attachment

This action adds an attachment in an issue.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Issue ID/Key

Enter the issue ID or key.

Example:

"CDPROJ-9"

Text

Required

File Path

Enter the local file path of the attachment.

Example:

"http://localhost:8080/jira/rest/api/2/issue/10009"

Text

Required

Example Request 

[
  {
    "issue_id": "CDPROJ-9",
    "filepath": "http://localhost:8080/jira/rest/api/2/issue/10009"
  }
]