Jira V3

Use the Jira integration to manage issues and create Cortex XSOAR incidents from Jira projects. From Cortex XSOAR version 6.0 and above, the integration also mirrors issues to existing issue incidents in Cortex XSOAR. The integration now supports both OnPrem, and Cloud instances.
This integration was integrated and tested with: Jira Cloud Platform V3 (for Cloud), Jira Software Cloud (for Cloud), Jira Server Platform 9.6.0 (for OnPrem), Jira Software Server 9.6.0 (for OnPrem).

Some changes have been made that might affect your existing content.
If you are upgrading from a previous version of this integration, see Breaking Changes.

Configure Atlassian Jira V3 on Cortex XSOAR

1. Navigate to Settings > Integrations > Servers & Services.
2. Search for Atlassian Jira V3.
3. Authentication: Basic Authentication, Personal Access Token, and OAuth 2.0 are used for Jira Cloud and On-prem. Read the Authentication process in order to configure your instance

4. Click Add instance to create and configure a new integration instance.

   Parameter	Description	Required
   Server URL	The base URL. For a Cloud instance, use the default URL as configured. For an OnPrem instance, use your respective domain.	True
   Cloud ID	This field is used to configure the Jira Cloud.
   User name	used only for basic authentication method	False
   API key	used only for basic authentication method	False
   Callback URL	used only for OAuth 2.0 method	False
   Client ID	used only for OAuth 2.0 method	False
   Client Secret	used only for OAuth 2.0 method	False
   Personal Access Token	used only for the Personal Access Token method	False
   Query (in JQL) for fetching incidents	The field that was selected in the “Issue Field to fetch by” can’t be used. in the query.	False
   Issue Field to fetch by	This is how the field (e.g, created date) is applied to the query: created >= {created date in last run} ORDER BY created ASC	False
   Issue index to start fetching incidents from	This parameter is dismissed if “id” is not chosen in “Issue Field to Fetch by”. This will only fetch Jira issues that are part of the same project as the issue that is configured in this parameter. If this value is 0, then the fetch mechanism will automatically start the fetch from the smallest ID with respect to the fetch query.	False
   Trust any certificate (not secure)		False
   Use system proxy settings		False
   Fetch incidents		False
   Incident type		False
   Close Mirrored XSOAR Incident	When selected, marking the Jira issue as resolved will be mirrored in Cortex XSOAR, and will close the corresponding incident. Please make sure the `Resolved` field in your Jira instance is configured in order for this to work properly, if not, it will rely on if the status of the issue is changed to `Done`.	False
   Mirroring Direction		False
   Attachment Entry Tag to Jira	Add this tag to an entry to mirror it as an attachment to Jira.	False
   Attachment Entry Tag from Jira	Add this tag to an entry to mirror it as an attachment from Jira.	False
   Comment Entry Tag to Jira	Add this tag to an entry to mirror it as a comment in Jira.	False
   Comment Entry Tag from Jira	Add this tag to an entry to mirror it as a comment from Jira.	False
   Fetch comments	Fetch comments for a Jira ticket.	False
   Fetch attachments	Fetch attachments for a Jira ticket.	False
   Max incidents per fetch	The maximum allowed value is dictated by the Jira property ‘jira.search.views.default.max’. If you specify a value that is higher than this number, your search results will be truncated. Default value is 50.	False
   Time range for initial data fetch	The time range to consider for the initial data fetch in format: <number> <unit>. This parameter is only relevant when selecting to fetch by created time, or updated time. Default is 3 days. For example: 2 minutes, 2 hours, 2 days, 2 months, 2 years	False

5. Check Authorization Flow In Cortex XSOAR in order to authenticate and test the connection.

Configure only one of the following fields:

• Cloud ID - Used for Jira Cloud instance.
• OnPrem - Leave the Cloud ID empty, and fill in the rest of the fields.

Cloud ID

1. Go to your Admin page.
2. Click the Products tab on the top banner and choose the appropriate site under Sites and Products on the left side bar. Your Cloud ID will appear in the URL:
   https://admin.atlassian.com/s/{cloud_id}/users

Authentication

Basic Authentication

Leave the Client ID, Client Secret and Personal Access Token fields empty and fill in the following fields:

• User name - Enter your user email.
• API key - Enter the API token. To generate API token, see here

Basic Authentication permissions

Ensure that you possess the necessary permissions by navigating to Project Settings > Permissions in the project.
Locate permissions for the tasks listed below:

• Browse projects
• Create issues
• Edit issues
• Delete issues
• Transition issues
• Create attachments
• Add comments
• Link issues

Personal Access Token Authentication

Leave the User name, API key, Client ID and Client Secret empty and fill in the following fields:

• Personal Access Token - Enter the Personal Access Token you created for a user, see here

OAuth 2.0

For both instances (Cloud ID & OnPrem), it is advised to use the https://oproxy.demisto.ninja/authcode Callback URL. The OProxy URL is a client side only web page which provides an easy interface to copy the obtained auth code from the authorization response to the integration configuration in the authorization flow steps. Optionally, if you don’t want to use the OProxy URL, you can use a localhost URL on a port that is not used locally on your machine. For example: http://localhost:9004. You will then need to copy the code from the URL address bar in the response (see OAuth 2.0 authorization Flow In Cortex XSOAR).

Cloud authentication

Go to your Developer console page, and choose the App you want to integrate with your instance. It must be of type OAuth 2.0. For creating a new app with type OAuth 2.0, click Create and choose OAuth 2.0 integration and follow the steps.

Callback URL

1. Go to the Authorization tab, and click Add on the authorization with type of OAuth 2.0 (3LO).
2. Insert a Callback URL.

Client ID, Client Secret

1. Go to the Settings tab.
2. Copy the Client ID and Secret to the Client ID and Client Secret fields, respectively.

Cloud Scopes

The integration uses the offline_access scope, in order to retrieve refresh tokens.

Classic Scopes

• read:jira-work
• read:jira-user
• write:jira-work

Granular Scopes

• read:jql:jira
• read:issue-details:jira
• write:board-scope:jira-software
• read:board-scope:jira-software
• read:sprint:jira-software
• read:epic:jira-software
• write:sprint:jira-software

OnPrem authentication

1. Log in to Jira as a user with Jira Administrator permissions.
2. Click the Jira Administration tab (the gear icon found in the top right corner) and click Applications.
3. To create a new Application link, which will be used to integrate Cortex XSOAR with Jira:
   a. Click Application links under Integrations, found on the left side menu.
   b. Click Create link and choose External application with the Incoming direction.
4. Fill in the required details as explained in the page, by inserting a Callback URL, and choosing the permission Write.
5. Once the link is created, you will be able to see Client ID, and the Client secret, which are required in the configuration screen. Copy these values and paste them into the respective fields in the configuration screen.

OnPrem Scopes

Write

OAuth 2.0 authorization Flow In Cortex XSOAR

1. Create the authentication application as explained in the OAuth 2.0 section.
2. Run the command !jira-oauth-start, where you will be presented with a URL to authenticate yourself.
3. After authenticating, you will be redirected to the configured Callback URL, where you will retrieve the authorization code provided as a query parameter called code.
4. Insert the retrieved authorization code as an argument to the !jira-oauth-complete command.
5. Run the !jira-oauth-test to test the connection of the instance.

Authenticating using custom callback URL

Authenticating using the oproxy callback URL

Fetch Incidents

When you enable incidents fetching, you have the option to configure a query which will be used to fetch Jira issues as incidents in Cortex XSOAR. The query uses one of the following fields in order to progressively fetch incidents:

• id of Jira issues
• created time of Jira issues
• updated time of Jira issues (using this field may cause duplicates, so be wary)

If created time, or updated time is selected when fetching incidents for the first time, then the Time range for initial data fetch argument is used in the fetch query.
By default, 50 issues are fetched for each call.
If Fetch comments is enabled, The fetched incidents will include the comments in the Jira issue, and preview them in the form of a table in the incident info tab.
If Fetch attachments is enabled, The fetched incidents will include the attachments in the Jira issue.

Note: Changing certain incidents fetching configuration parameters, such as Issue Field to fetch by on the fly may result in unintended side effects and behaviors, including duplicate or missing incidents. It is recommended to reset the “last run” timestamp before applying such changes or, preferably, configure a new integration instance with the new fetch configuration.

Commands

You can execute these commands from the Cortex XSOAR CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.

Notes:

1. For OnPrem, all the commands use the WRITE scope, for Cloud, the required scopes for each command will be mentioned under the name of the command.
2. For the commands that are shared between Jira V2 and V3, we still support the arguments from V2, but are configured to be hidden, and are prioritized when supplied to the commands, to not break backwards compatibility.

jira-issue-get-attachment

Download attachments for a specific issue (Will download a file to War Room).

Scope: read:jira-work

Base Command

jira-issue-get-attachment

Input

Context Output

Command example

!jira-issue-get-attachment attachment_id=16477

Context Example

{
    "InfoFile": {
        "EntryID": "10906@33e912c0-76a9-4a08-8cc6-1b20b1980b20",
        "Extension": "pdf",
        "Info": "application/pdf",
        "Name": "dummy.pdf",
        "Size": 13264,
        "Type": "PDF document, version 1.4, 1 pages (zip deflate encoded)"
    }
}

Human Readable Output

jira-delete-issue

Deletes an issue in Jira. Issue’s sub-tasks will also be deleted if there are any.

Scope: write:jira-work

Base Command

jira-delete-issue

Input

Context Output

There is no context output for this command.

Command example

!jira-delete-issue issue_key=PROJECTKEY-114

Human Readable Output

Issue deleted successfully.

jira-get-specific-field

Gets specific fields from a Jira issue and adds it to context dynamically.

Scope: read:jira-work

Base Command

jira-get-specific-field

Input

Context Output

Command example

!jira-get-specific-field issue_key=PROJECTKEY-35 fields="watches,rank"

Context Example

{
    "Ticket": {
        "Assignee": "Example User(example@example.com)",
        "Attachments": [
            {
                "created": "2023-05-04T21:11:51.286+0300",
                "filename": "dummy_attachment_content.txt",
                "id": "16475",
                "size": 13264
            },
            {
                "created": "2023-05-04T21:32:57.042+0300",
                "filename": "dummy.pdf",
                "id": "16478",
                "size": 13264
            }
        ],
        "Components": [
            "dummy-comp",
            "Integration"
        ],
        "Created": "2023-03-01T11:34:49.730+0200",
        "Creator": "Example User(example@example.com)",
        "Description": "Edited subbscription",
        "DueDate": "2023-01-01",
        "Id": "21487",
        "Key": "PROJECTKEY-35",
        "Labels": [
            "label1",
            "label2"
        ],
        "LastSeen": "2023-05-08T19:02:34.151+0300",
        "LastUpdate": "2023-05-08T19:07:44.900+0300",
        "Priority": "Highest",
        "ProjectName": "Company Snoozing App",
        "Status": "Backlog",
        "Summary": "Edited Summary",
        "customfield_10019": {
            "issueFieldDisplayName": "Rank",
            "rawData": "0|i00kjb:"
        },
        "watches": {
            "issueFieldDisplayName": "Watchers",
            "rawData": {
                "isWatching": true,
                "self": "https://api.atlassian.com/ex/jira/1234/rest/api/3/issue/PROJECTKEY-35/watchers",
                "watchCount": 1
            }
        }
    }
}

Human Readable Output

Issue PROJECTKEY-35

Assignee	Created	Creator	Description	Due Date	Id	Issue Type	Key	Labels	Priority	Project Name	Reporter	Status	Summary	Ticket Link
Example User(example@example.com)	2023-03-01T11:34:49.730+0200	Example User(example@example.com)	Edited subbscription	2023-01-01	21487	Story	PROJECTKEY-35	label1, label2	Highest	Company Snoozing App	Example User(example@example.com)	Backlog	Edited Summary	https://api.atlassian.com/ex/jira/1234/rest/api/3/issue/21487

jira-issue-add-link

Creates (or updates) an issue link.

Scope: write:jira-work

Base Command

jira-issue-add-link

Input

Context Output

There is no context output for this command.

Command example

!jira-issue-add-link title="Demo" url="https://demisto.com" issue_key=PROJECTKEY-35

Human Readable Output

Remote Issue Link

id	ticket_link
16506	https://api.atlassian.com/ex/jira/1234/rest/api/3/issue/PROJECTKEY-35/remotelink/16506

jira-get-id-by-attribute

Gets the account ID for a given user attribute.

Scope: read:jira-user

Base Command

jira-get-id-by-attribute

Input

Context Output

Command example

!jira-get-id-by-attribute attribute=Tomer

Context Example

{
    "Jira": {
        "User": {
            "AccountId": "12345",
            "Attribute": "Tomer"
        }
    }
}

Human Readable Output

The account ID that holds the attribute Tomer: 12345

jira-issue-query

Queries Jira issues.

Scope: read:jira-work

Base Command

jira-issue-query

Input

Context Output

Command example

!jira-issue-query query="status!=done" max_results=2 fields="watches,rank"

Context Example

{
    "Ticket": [
        {
            "Assignee": "",
            "Attachments": [
                {
                    "created": "2023-03-26T18:06:24.325+0300",
                    "filename": "DemistoContent-InstallContentEnvironment-160822-0023-68.pdf",
                    "id": "16426",
                    "size": 17815
                }
            ],
            "Components": [],
            "Created": "2023-03-01T11:59:18.202+0200",
            "Creator": "Example User(example@example.com)",
            "Description": "Dummy description",
            "DueDate": "",
            "Id": "21490",
            "Key": "XSOAR-19",
            "Labels": [],
            "LastSeen": "",
            "LastUpdate": "2023-05-04T21:41:44.516+0300",
            "Priority": "Highest",
            "ProjectName": "XSOARJiraV3",
            "Status": "To Do",
            "Summary": "something",
            "customfield_10019": {
                "issueFieldDisplayName": "Rank",
                "rawData": "0|i00kjr:"
            },
            "watches": {
                "issueFieldDisplayName": "Watchers",
                "rawData": {
                    "isWatching": true,
                    "self": "https://api.atlassian.com/ex/jira/1234/rest/api/3/issue/XSOAR-19/watchers",
                    "watchCount": 1
                }
            }
        },
        {
            "Assignee": "",
            "Attachments": [],
            "Components": [],
            "Created": "2023-03-01T14:10:55.495+0200",
            "Creator": "Example User(example@example.com)",
            "Description": "Dummy",
            "DueDate": "",
            "Id": "21494",
            "Key": "XSOAR-18",
            "Labels": [],
            "LastSeen": "",
            "LastUpdate": "2023-03-01T14:10:55.495+0200",
            "Priority": "Medium",
            "ProjectName": "XSOARJiraV3",
            "Status": "To Do",
            "Summary": "something something",
            "customfield_10019": {
                "issueFieldDisplayName": "Rank",
                "rawData": "0|i00kkn:"
            },
            "watches": {
                "issueFieldDisplayName": "Watchers",
                "rawData": {
                    "isWatching": true,
                    "self": "https://api.atlassian.com/ex/jira/1234/rest/api/3/issue/XSOAR-18/watchers",
                    "watchCount": 1
                }
            }
        }
    ]
}

Human Readable Output

Issue XSOAR-19

Assignee	Created	Creator	Description	Due Date	Id	Issue Type	Key	Labels	Priority	Project Name	Reporter	Status	Summary	Ticket Link
	2023-03-01T11:59:18.202+0200	Example User(example@example.com)	Dummy description		21490	Task	XSOAR-19		Highest	XSOARJiraV3	Example User(example@example.com)	To Do	something	https://api.atlassian.com/ex/jira/1234/rest/api/3/issue/21490

Issue XSOAR-18

Assignee	Created	Creator	Description	Due Date	Id	Issue Type	Key	Labels	Priority	Project Name	Reporter	Status	Summary	Ticket Link
	2023-03-01T14:10:55.495+0200	Example User(example@example.com)	Dummy		21494	Task	XSOAR-18		Medium	XSOARJiraV3	Example User(example@example.com)	To Do	something something	https://api.atlassian.com/ex/jira/1234/rest/api/3/issue/21494

jira-get-id-offset

Returns the ID offset, which is the ID of the first issue that was created in the current Jira instance, or the ID of the first issue with respect to the given query argument if given. You can use its result as the initial ID when fetching incidents by the issue id field.

Scope: read:jira-work

Base Command

jira-get-id-offset

Input

Context Output

Command example

!jira-get-id-offset query="status!=done"

Context Example

{
    "Ticket": {
        "idOffSet": "10161"
    }
}

Human Readable Output

ID Offset: 10161

jira-issue-add-comment

Adds a new comment to an existing Jira issue.

Scope: write:jira-work

Base Command

jira-issue-add-comment

Input

Context Output

There is no context output for this command.

Command example

!jira-issue-add-comment issue_key=PROJECTKEY-31 comment="New comment"

Human Readable Output

Comment added successfully

Comment	Id	Ticket Link
New comment	18456	https://api.atlassian.com/ex/jira/1234/rest/api/3/issue/21432/comment/18456

jira-issue-upload-file

Uploads a file attachment to an issue.

Scope: write:jira-work

Base Command

jira-issue-upload-file

Input

Context Output

There is no context output for this command.

Command example

!jira-issue-upload-file upload=10833@33e912c0-76a9-4a08-8cc6-1b20b1980b20 issue_key=PROJECTKEY-31

Human Readable Output

Attachment added successfully

Attachment Link	Attachment Name	Id	Issue Key
https://api.atlassian.com/ex/jira/1234/rest/api/3/attachment/16505	dummy.pdf	16505	PROJECTKEY-31

jira-issue-delete-file

Delete an attachment from an issue.

Scope: write:jira-work

Base Command

jira-issue-delete-file

Input

Context Output

There is no context output for this command.

Command example

!jira-issue-delete-file attachment_id=ATTACHMENT_ID

Human Readable Output

Attachment id ATTACHMENT_ID was deleted successfully.

jira-list-transitions

Lists all possible transitions for a given ticket in its current status.

Scope: read:jira-work

Base Command

jira-list-transitions

Input

Context Output

Command example

!jira-list-transitions issue_key=PROJECTKEY-35

Context Example

{
    "Ticket": {
        "Key": "PROJECTKEY-35",
        "Transitions": {
            "ticketId": "PROJECTKEY-35",
            "transitions": [
                "Backlog",
                "In Development"
            ]
        }
    }
}

Human Readable Output

List Transitions

Transition Names
Backlog
In Development

jira-edit-issue

Modifies an issue in Jira. If the status or transition fields are given, then the other supplied fields should appear on the transition screen.

Scope: write:jira-work

Base Command

jira-edit-issue

Input

Context Output

Command example

!jira-edit-issue action=rewrite issue_key=PROJECTKEY-35 assignee_id=12345 description="Edited subbscription" due_date="2023-01-01" environment="Windows XP" labels="label1,label2" priority="Highest" security=Anyone status="Backlog" summary="Edited Summary"

Context Example

{
    "Ticket": {
        "Assignee": "Example User(example@example.com)",
        "Attachments": [
            {
                "created": "2023-05-07T20:00:59.121+0300",
                "filename": "dummy_attachment_content.txt",
                "id": "16504",
                "size": 13264
            },
            {
                "created": "2023-05-04T21:29:49.246+0300",
                "filename": "dummy.pdf",
                "id": "16477",
                "size": 13264
            }
        ],
        "Components": [
            "dummy-comp",
            "Integration"
        ],
        "Created": "2023-03-01T11:34:49.730+0200",
        "Creator": "Example User(example@example.com)",
        "Description": "Edited subbscription",
        "DueDate": "2023-01-01",
        "Id": "21487",
        "Key": "PROJECTKEY-35",
        "Labels": [
            "label1",
            "label2"
        ],
        "LastSeen": "2023-05-08T19:02:34.151+0300",
        "LastUpdate": "2023-05-08T19:07:44.900+0300",
        "Priority": "Highest",
        "ProjectName": "Company Snoozing App",
        "Status": "Backlog",
        "Summary": "Edited Summary"
    }
}

Human Readable Output

Issue PROJECTKEY-35

Assignee	Created	Creator	Description	Due Date	Id	Issue Type	Key	Labels	Priority	Project Name	Reporter	Status	Summary	Ticket Link
Example User(example@example.com)	2023-03-01T11:34:49.730+0200	Example User(example@example.com)	Edited subbscription	2023-01-01	21487	Story	PROJECTKEY-35	label1, label2	Highest	Company Snoozing App	Example User(example@example.com)	Backlog	Edited Summary	https://api.atlassian.com/ex/jira/1234/rest/api/3/issue/21487

jira-issue-assign

Assigns an assignee to an existing issue.

Scope: write:jira-work

Base Command

jira-issue-assign

Input

Context Output

Command example

!jira-issue-assign issue_key=PROJECTKEY-35 assignee_id=12345

Context Example

{
    "Ticket": {
        "Assignee": "Example User(example@example.com)",
        "Attachments": [
            {
                "created": "2023-05-07T20:00:59.121+0300",
                "filename": "dummy_attachment_content.txt",
                "id": "16504",
                "size": 13264
            },
            {
                "created": "2023-05-04T21:29:49.246+0300",
                "filename": "dummy.pdf",
                "id": "16477",
                "size": 13264
            }
        ],
        "Components": [
            "dummy-comp",
            "Integration"
        ],
        "Created": "2023-03-01T11:34:49.730+0200",
        "Creator": "Example User(example@example.com)",
        "Description": "Edited subbscription",
        "DueDate": "2023-01-01",
        "Id": "21487",
        "Key": "PROJECTKEY-35",
        "Labels": [
            "label1",
            "label2"
        ],
        "LastSeen": "2023-05-08T19:02:34.151+0300",
        "LastUpdate": "2023-05-08T19:07:44.900+0300",
        "Priority": "Highest",
        "ProjectName": "Company Snoozing App",
        "Status": "Backlog",
        "Summary": "Edited Summary"
    }
}

Human Readable Output

Issue PROJECTKEY-35

Assignee	Created	Creator	Description	Due Date	Id	Issue Type	Key	Labels	Priority	Project Name	Reporter	Status	Summary	Ticket Link
Example User(example@example.com)	2023-03-01T11:34:49.730+0200	Example User(example@example.com)	Edited subbscription	2023-01-01	21487	Story	PROJECTKEY-35	label1, label2	Highest	Company Snoozing App	Example User(example@example.com)	Backlog	Edited Summary	https://api.atlassian.com/ex/jira/1234/rest/api/3/issue/21487

jira-create-issue

Creates a new issue in Jira.

Scope: write:jira-work

Base Command

jira-create-issue

Input

Context Output

Command example

!jira-create-issue summary="Dummy Summary" assignee_id=12345 components="dummy-comp,New-Component" description="Dummy description" due_date="2023-01-01" environment="Windows XP" issue_type_name="Sub-task" labels="label1,label2" parent_issue_key=PROJECTKEY-35 priority=Highest project_name="Company Snoozing App" reporter_id=12345 security=Assignee

Context Example

{
    "Ticket": {
        "Id": "21619",
        "Key": "PROJECTKEY-145"
    }
}

Human Readable Output

Issue PROJECTKEY-145

Id	Key	Project Key	Ticket Link
21619	PROJECTKEY-145	PROJECTKEY	https://api.atlassian.com/ex/jira/1234/rest/api/3/issue/21619

jira-get-issue

Fetches an issue from Jira.

Scope: read:jira-work

Base Command

jira-get-issue

Input

Note: When supplying the all value to the fields argument, then all the issue fields will be returned, and every issue field that was not parsed by the code, will be parsed in the following format: {customfield_1: SOME_NESTED_VALUE} -> {customfield_1: {issueFieldDisplayName: THE_DISPLAY_NAME_OF_THE_FIELD, rawData: SOME_NESTED_VALUE}}

Context Output

Command example

!jira-get-issue issue_key=PROJECTKEY-35 expand_links=true fields=watches,rank get_attachments=true

Context Example

{
    "InfoFile": [
        {
            "EntryID": "10845@33e912c0-76a9-4a08-8cc6-1b20b1980b20",
            "Extension": "png",
            "Info": "image/png",
            "Name": "1682340338180_home_screen_background_mirrored_from_xsoar.png",
            "Size": 212597,
            "Type": "PNG image data, 430 x 932, 8-bit/color RGBA, non-interlaced"
        },
        {
            "EntryID": "10846@33e912c0-76a9-4a08-8cc6-1b20b1980b20",
            "Extension": "txt",
            "Info": "text/plain; charset=utf-8",
            "Name": "dummy_attachment_content.txt",
            "Size": 13264,
            "Type": "PDF document, version 1.4, 1 pages (zip deflate encoded)"
        }
    ],
    "Ticket": [
        {
            "Assignee": "Example User(example@example.com)",
            "Attachments": [
                {
                    "created": "2023-04-24T15:46:18.919+0300",
                    "filename": "1682340338180_home_screen_background_mirrored_from_xsoar.png",
                    "id": "16466",
                    "size": 212597
                },
                {
                    "created": "2023-05-07T20:00:59.121+0300",
                    "filename": "dummy_attachment_content.txt",
                    "id": "16504",
                    "size": 13264
                }
            ],
            "Components": [
                "dummy-comp",
                "Integration"
            ],
            "Created": "2023-03-01T11:34:49.730+0200",
            "Creator": "Example User(example@example.com)",
            "Description": "Edited subbscription",
            "DueDate": "2023-01-01",
            "Id": "21487",
            "Key": "PROJECTKEY-35",
            "Labels": [
                "label1",
                "label2"
            ],
            "LastSeen": "2023-05-08T19:02:34.151+0300",
            "LastUpdate": "2023-05-08T19:05:03.569+0300",
            "Priority": "Highest",
            "ProjectName": "Company Snoozing App",
            "Status": "Selected for Development",
            "Summary": "Edited Summary",
            "customfield_10019": {
                "issueFieldDisplayName": "Rank",
                "rawData": "0|i00kjb:"
            },
            "watches": {
                "issueFieldDisplayName": "Watchers",
                "rawData": {
                    "isWatching": true,
                    "self": "https://api.atlassian.com/ex/jira/1234/rest/api/3/issue/PROJECTKEY-35/watchers",
                    "watchCount": 1
                }
            }
        },
        {
            "Assignee": "",
            "Attachments": [
                {
                    "created": "2023-03-26T18:06:24.325+0300",
                    "filename": "DemistoContent-InstallContentEnvironment-160822-0023-68.pdf",
                    "id": "16426",
                    "size": 17815
                }
            ],
            "Components": [],
            "Created": "2023-03-01T11:59:18.202+0200",
            "Creator": "Example User(example@example.com)",
            "Description": "Dummy description",
            "DueDate": "",
            "Id": "21490",
            "Key": "XSOAR-19",
            "Labels": [],
            "LastSeen": "",
            "LastUpdate": "2023-05-04T21:41:44.516+0300",
            "Priority": "Highest",
            "ProjectName": "XSOARJiraV3",
            "Status": "To Do",
            "Summary": "something",
            "customfield_10019": {
                "issueFieldDisplayName": "Rank",
                "rawData": "0|i00kjr:"
            },
            "watches": {
                "issueFieldDisplayName": "Watchers",
                "rawData": {
                    "isWatching": true,
                    "self": "https://api.atlassian.com/ex/jira/1234/rest/api/3/issue/XSOAR-19/watchers",
                    "watchCount": 1
                }
            }
        }
    ]
}

Human Readable Output

Issue COMPANYSA-35

Assignee	Created	Creator	Description	Due Date	Id	Issue Type	Key	Labels	Priority	Project Name	Reporter	Status	Summary	Ticket Link
Example User(example@example.com)	2023-03-01T11:34:49.730+0200	Example User(example@example.com)	hi	2023-05-24	21487	Story	COMPANYSA-35	label1, label2	Highest	Company Snoozing App	Example User(example@example.com)	In Progress	XSOAR Meeting, Ammended summary	https://api.atlassian.com/ex/jira/15d0e445-bd38-483c-b3fd-d15f562f369b/rest/api/3/issue/21487

Issue XSOAR-19

Assignee	Created	Creator	Description	Due Date	Id	Issue Type	Key	Labels	Priority	Project Name	Reporter	Status	Summary	Ticket Link
	2023-03-01T11:59:18.202+0200	Example User(example@example.com)	Dummy description		21490	Task	XSOAR-19		Highest	XSOARJiraV3	Example User(example@example.com)	To Do	something	https://api.atlassian.com/ex/jira/1234/rest/api/3/issue/21490

jira-get-comments

Returns the comments added to a ticket.

Scope: read:jira-work

Base Command

jira-get-comments

Input

Context Output

Command example

!jira-get-comments issue_key=PROJECTKEY-35 limit=2

Context Example

{
    "Ticket": {
        "Comment": [
            {
                "Comment": "New comment",
                "Created": "2023-05-04T21:29:51.036+0300",
                "Id": "18423",
                "UpdateUser": "Example User",
                "Updated": "2023-05-04T21:29:51.036+0300",
                "User": "Example User"
            },
            {
                "Comment": "Dummy Link",
                "Created": "2023-05-04T21:30:29.599+0300",
                "Id": "18424",
                "UpdateUser": "Example User",
                "Updated": "2023-05-04T21:30:29.599+0300",
                "User": "Example User"
            }
        ],
        "Id": "21487",
        "Key": "PROJECTKEY-35"
    }
}

Human Readable Output

Comments

Comment	Created	Id	UpdateUser	Updated	User
New comment	2023-05-04T21:29:51.036+0300	18423	Example User	2023-05-04T21:29:51.036+0300	Example User
Dummy Link	2023-05-04T21:30:29.599+0300	18424	Example User	2023-05-04T21:30:29.599+0300	Example User

jira-oauth-complete

Use this command to complete the authorization process. After copying the authorization code found in the query parameter code of the callback URL, paste the value in the command as an argument to finish the process.

Base Command

jira-oauth-complete

Input

Context Output

There is no context output for this command.

Human Readable Output

Logged in successfully

A refresh token was saved to the integration context. This token will be
used to generate a new access token once the current one expires.

jira-oauth-start

Use this command to start the authorization process. In order to authorize the instance, first run the command, and complete the process in the URL that is returned. You will then be redirected to the callback URL where you will copy the authorization code found in the query parameter code, and paste that value in the command !jira-ouath-complete as an argument to finish the process.

Base Command

jira-oauth-start

Input

There are no input arguments for this command.

Context Output

There is no context output for this command.

Human Readable Output

In order to retrieve the authorization code, use the following link:
https://example.com
After authorizing, you will be redirected to the configured callback URL, where you will retrieve the authorization code provided as a query parameter called code, and insert it as an argument to the !jira-oauth-complete command

jira-oauth-test

Use this command to test the connectivity of the Jira instance.

Base Command

jira-oauth-test

Input

There are no input arguments for this command.

Context Output

There is no context output for this command.

Human Readable Output

Successful connection.

jira-issue-delete-comment

Delete a comment from an issue.

Scope: write:jira-work

Base Command

jira-issue-delete-comment

Input

Context Output

There is no context output for this command.

Command example

!jira-issue-delete-comment issue_key=PROJECTKEY-35 comment_id=18423

Human Readable Output

Comment deleted successfully.

jira-issue-edit-comment

Edit a comment that is part of an issue.

Scope: write:jira-work

Base Command

jira-issue-edit-comment

Input

Context Output

Command example

!jira-issue-edit-comment issue_key=PROJECTKEY-35 comment_id=18425 comment="New Hello There"

Context Example

{
    "Ticket": {
        "Comment": [
            {
                "Comment": "Dummy Link",
                "Created": "2023-05-04T21:30:29.599+0300",
                "Id": "18424",
                "UpdateUser": "Example User",
                "Updated": "2023-05-04T21:30:29.599+0300",
                "User": "Example User"
            },
            {
                "Comment": "New Hello There",
                "Created": "2023-05-04T21:32:58.870+0300",
                "Id": "18425",
                "UpdateUser": "Example User",
                "Updated": "2023-05-08T19:08:04.346+0300",
                "User": "Example User"
            },
            {
                "Comment": "Dummy Link",
                "Created": "2023-05-04T21:33:29.986+0300",
                "Id": "18426",
                "UpdateUser": "Example User",
                "Updated": "2023-05-04T21:33:29.986+0300",
                "User": "Example User"
            }
        ],
        "Id": "21487",
        "Key": "PROJECTKEY-35"
    }
}

Human Readable Output

The comment has been edited successfully

jira-issue-list-fields

This command returns the issue fields, both system and custom fields.

Scope: read:jira-work

Base Command

jira-issue-list-fields

Input

Context Output

Command example

!jira-issue-list-fields page=1 page_size=2

Context Example

{
    "Jira": {
        "IssueField": [
            {
                "clauseNames": [],
                "custom": true,
                "id": "customfield_10070",
                "key": "customfield_10070",
                "name": "Responders",
                "navigable": true,
                "orderable": true,
                "schema": {
                    "custom": "com.atlassian.jira.modules.servicemanagement.responders-entity:responders-entity-field-cftype",
                    "customId": 10070,
                    "items": "string",
                    "type": "array"
                },
                "searchable": true,
                "untranslatedName": "Responders"
            },
            {
                "clauseNames": [
                    "cf[10071]",
                    "Time to resolution"
                ],
                "custom": true,
                "id": "customfield_10071",
                "key": "customfield_10071",
                "name": "Time to resolution",
                "navigable": true,
                "orderable": true,
                "schema": {
                    "custom": "com.atlassian.servicedesk:sd-sla-field",
                    "customId": 10071,
                    "type": "sd-servicelevelagreement"
                },
                "searchable": true,
                "untranslatedName": "Time to resolution"
            }
        ]
    }
}

Human Readable Output

Issue Fields

Custom	Id	Name	Schema Type	Searchable
true	customfield_10070	Responders	array	true
true	customfield_10071	Time to resolution	sd-servicelevelagreement	true

jira-issue-to-backlog

Moves issues to backlog. If the issues supplied are NOT part of a board that supports sprints, then the board_id argument is required. At most 50 issues may be moved at once.

Scope: write:board-scope:jira-software

Base Command

jira-issue-to-backlog

Input

Context Output

There is no context output for this command.

Command example

!jira-issue-to-backlog issues="TSTPRD-3,TSTPRD-6" rank_before_issue="TSTPRD-4" board_id=12

Human Readable Output

Issues were moved to Backlog successfully

jira-issue-to-board

Moves issues from backlog to board, the command does not work with boards with sprints. At most 50 issues may be moved at once. This command is only supported for Jira Cloud instances.

Scope: write:board-scope:jira-software

Base Command

jira-issue-to-board

Input

Context Output

There is no context output for this command.

Command example

!jira-issue-to-board issues="PROJECTKEY-35,PROJECTKEY-39" board_id=14

Human Readable Output

Issues were moved to Board successfully

jira-board-list

Get board data. If board_id is given, then only the board that corresponds to the board_id is returned, otherwise, the the command will return boards that match the project_key_id, type, or board_name arguments.

Scopes: read:board-scope:jira-software, read:issue-details:jira

Base Command

jira-board-list

Input

Context Output

Command example

!jira-board-list project_key_id=PROJECTKEY type=kanban

Context Example

{
    "Jira": {
        "Board": {
            "id": 14,
            "location": {
                "avatarURI": "https://api.atlassian.com/ex/jira/1234/rest/api/2/universal_avatar/view/type/project/avatar/10402?size=small",
                "displayName": "Company Snoozing App (PROJECTKEY)",
                "name": "Company Snoozing App (PROJECTKEY)",
                "projectId": 10022,
                "projectKey": "PROJECTKEY",
                "projectName": "Company Snoozing App",
                "projectTypeKey": "software"
            },
            "name": "PROJECTKEY board",
            "self": "https://api.atlassian.com/ex/jira/1234/rest/agile/1.0/board/14",
            "type": "kanban"
        }
    }
}

Human Readable Output

Boards

ID	Name	Project ID	Project Name	Type
14	PROJECTKEY board	10022	Company Snoozing App	kanban

jira-board-backlog-list

Get issues from the backlog of a specific board. For Jira OnPrem, the board must be of type scrum.

Scopes: read:board-scope:jira-software, read:issue-details:jira

Base Command

jira-board-backlog-list

Input

Context Output

Command example

!jira-board-backlog-list board_id=14 jql_query="status!=done" limit=2

Context Example

{
    "Jira": {
        "BoardBacklog": {
            "Ticket": [
                {
                    "Assignee": "",
                    "Attachments": [],
                    "Components": [],
                    "Created": "2023-01-01T22:57:28.689+0200",
                    "Creator": "Example User(example@example.com)",
                    "Description": "",
                    "DueDate": "",
                    "Id": "21360",
                    "Key": "PROJECTKEY-1",
                    "Labels": [],
                    "LastSeen": "",
                    "LastUpdate": "2023-03-07T17:31:48.332+0200",
                    "Priority": "Medium",
                    "ProjectName": "Company Snoozing App",
                    "Status": "Backlog",
                    "Summary": "Start creating the company snoozing app"
                },
                {
                    "Assignee": "Example User()",
                    "Attachments": [],
                    "Components": [
                        "Integration"
                    ],
                    "Created": "2023-01-30T16:42:47.476+0200",
                    "Creator": "Example User(example@example.com)",
                    "Description": "Complete this issue",
                    "DueDate": "2023-09-09",
                    "Id": "21424",
                    "Key": "PROJECTKEY-30",
                    "Labels": [
                        "collab",
                        "good_job"
                    ],
                    "LastSeen": "",
                    "LastUpdate": "2023-03-13T21:09:47.898+0200",
                    "Priority": "Highest",
                    "ProjectName": "Company Snoozing App",
                    "Status": "Backlog",
                    "Summary": "Issue for demo"
                }
            ],
            "boardId": "14"
        }
    }
}

Human Readable Output

Backlog Issues

Assignee	Created	Creator	Description	DueDate	Id	IssueType	Key	Labels	Priority	ProjectName	Reporter	Status	Summary	TicketLink
	2023-01-01T22:57:28.689+0200	Example User(example@example.com)			21360	Epic	PROJECTKEY-1		Medium	Company Snoozing App	Example User(example@example.com)	Backlog	Start creating the company snoozing app	https://api.atlassian.com/ex/jira/1234/rest/agile/1.0/issue/21360
Example User()	2023-01-30T16:42:47.476+0200	Example User(example@example.com)	Complete this issue	2023-09-09	21424	Epic	PROJECTKEY-30	collab, good_job	Highest	Company Snoozing App	Example User()	Backlog	Issue for demo	https://api.atlassian.com/ex/jira/1234/rest/agile/1.0/issue/21424

jira-board-issue-list

Get all issues from a specific board.

Scopes: read:board-scope:jira-software, read:issue-details:jira

Base Command

jira-board-issue-list

Input

Context Output

Command example

!jira-board-issue-list board_id=14 jql_query="status!=done" limit=2

Context Example

{
    "Jira": {
        "BoardIssue": {
            "Ticket": [
                {
                    "Assignee": "Example User()",
                    "Attachments": [],
                    "Components": [
                        "comp2",
                        "Integration",
                        "test_test"
                    ],
                    "Created": "2023-01-30T16:35:50.482+0200",
                    "Creator": "Example User(example@example.com)",
                    "Description": "",
                    "DueDate": "2023-09-09",
                    "Id": "21423",
                    "Key": "PROJECTKEY-29",
                    "Labels": [
                        "Demisto",
                        "XSOAR",
                        "testnow"
                    ],
                    "LastSeen": "2023-05-07T17:40:56.751+0300",
                    "LastUpdate": "2023-03-26T18:26:06.762+0300",
                    "Priority": "Low",
                    "ProjectName": "Company Snoozing App",
                    "Status": "Selected for Development",
                    "Summary": "Issue for demo"
                },
                {
                    "Assignee": "",
                    "Attachments": [
                        {
                            "created": "2023-01-22T16:43:29.878+0200",
                            "filename": "Screen Shot 2022-10-19 at 20.09.46.png",
                            "id": "16387",
                            "size": 450738
                        },
                        {
                            "created": "2023-02-05T21:11:43.429+0200",
                            "filename": "stam.png",
                            "id": "16399",
                            "size": 450738
                        }
                    ],
                    "Components": [],
                    "Created": "2023-01-03T10:25:17.257+0200",
                    "Creator": "Example User(example@example.com)",
                    "Description": "This issue is for creating the home page.",
                    "DueDate": "",
                    "Id": "21361",
                    "Key": "PROJECTKEY-2",
                    "Labels": [
                        "Demisto",
                        "testnow"
                    ],
                    "LastSeen": "",
                    "LastUpdate": "2023-02-26T18:24:04.172+0200",
                    "Priority": "Medium",
                    "ProjectName": "Company Snoozing App",
                    "Status": "Selected for Development",
                    "Summary": "Create Home Page (including the log in option)"
                }
            ],
            "boardId": "14"
        }
    }
}

Human Readable Output

Board Issues

Assignee	Created	Creator	Description	DueDate	Id	IssueType	Key	Labels	Priority	ProjectName	Reporter	Status	Summary	TicketLink
Example User()	2023-01-30T16:35:50.482+0200	Example User(example@example.com)		2023-09-09	21423	Sub-task	PROJECTKEY-29	Demisto, XSOAR, testnow	Low	Company Snoozing App	Example User()	Selected for Development	Issue for demo	https://api.atlassian.com/ex/jira/1234/rest/agile/1.0/issue/21423
	2023-01-03T10:25:17.257+0200	Example User(example@example.com)	This issue is for creating the home page.		21361	Story	PROJECTKEY-2	Demisto, testnow	Medium	Company Snoozing App	Example User(example@example.com)	Selected for Development	Create Home Page (including the log in option)	https://api.atlassian.com/ex/jira/1234/rest/agile/1.0/issue/21361

jira-board-sprint-list

Get all sprints of a specific board.

Scope: read:sprint:jira-software

Base Command

jira-board-sprint-list

Input

Context Output

Command example

!jira-board-sprint-list board_id=12

Context Example

{
    "Jira": {
        "BoardSprint": {
            "Sprints": [
                {
                    "endDate": "2023-02-27T15:12:00.000Z",
                    "goal": "",
                    "id": 4,
                    "name": "TSTPRD Sprint 1",
                    "originBoardId": 12,
                    "self": "https://api.atlassian.com/ex/jira/1234/rest/agile/1.0/sprint/4",
                    "startDate": "2023-02-13T15:12:39.565Z",
                    "state": "active"
                },
                {
                    "endDate": "2023-02-23T14:57:00.000Z",
                    "goal": "Goal",
                    "id": 5,
                    "name": "TSTPRD Sprint 2",
                    "originBoardId": 12,
                    "self": "https://api.atlassian.com/ex/jira/1234/rest/agile/1.0/sprint/5",
                    "startDate": "2023-02-07T14:57:00.000Z",
                    "state": "future"
                },
                {
                    "id": 6,
                    "name": "TSTPRD Sprint 3",
                    "originBoardId": 12,
                    "self": "https://api.atlassian.com/ex/jira/1234/rest/agile/1.0/sprint/6",
                    "state": "future"
                }
            ],
            "boardId": "12"
        }
    }
}

Human Readable Output

Sprints

End Date	ID	Name	Start Date	State
2023-02-27T15:12:00.000Z	4	TSTPRD Sprint 1	2023-02-13T15:12:39.565Z	active
2023-02-23T14:57:00.000Z	5	TSTPRD Sprint 2	2023-02-07T14:57:00.000Z	future
	6	TSTPRD Sprint 3		future

jira-board-epic-list

Get all epics from a specific board

Scope: read:epic:jira-software

Base Command

jira-board-epic-list

Input

Context Output

Command example

!jira-board-epic-list board_id=14

Context Example

{
    "Jira": {
        "BoardEpic": {
            "Epics": [
                {
                    "color": {
                        "key": "color_4"
                    },
                    "done": false,
                    "id": 21360,
                    "key": "PROJECTKEY-1",
                    "name": "Create Company Snoozing App",
                    "self": "https://api.atlassian.com/ex/jira/1234/rest/agile/1.0/epic/21360",
                    "summary": "Start creating the company snoozing app"
                },
                {
                    "color": {
                        "key": "color_3"
                    },
                    "done": false,
                    "id": 21424,
                    "key": "PROJECTKEY-30",
                    "name": "New Epic",
                    "self": "https://api.atlassian.com/ex/jira/1234/rest/agile/1.0/epic/21424",
                    "summary": "Issue for demo"
                }
            ],
            "boardId": "14"
        }
    }
}

Human Readable Output

Epics

Done	ID	Key	Name	Summary
false	21360	PROJECTKEY-1	Create Company Snoozing App	Start creating the company snoozing app
false	21424	PROJECTKEY-30	New Epic	Issue for demo

jira-sprint-issue-list

Get all issues in a sprint.

Scopes: read:sprint:jira-software, read:issue-details:jira, read:jql:jira

Base Command

jira-sprint-issue-list

Input

Context Output

Command example

!jira-sprint-issue-list sprint_id=4

Context Example

{
    "Jira": {
        "SprintIssues": {
            "Ticket": [
                {
                    "Assignee": "",
                    "Attachments": [],
                    "Components": [],
                    "Created": "2023-02-02T17:59:21.527+0200",
                    "Creator": "Example User(example@example.com)",
                    "Description": "Please finish this ASAP.",
                    "DueDate": "",
                    "Id": "21430",
                    "Key": "TSTPRD-5",
                    "Labels": [],
                    "LastSeen": "2023-05-07T19:11:24.324+0300",
                    "LastUpdate": "2023-05-07T19:11:25.682+0300",
                    "Priority": "Medium",
                    "ProjectName": "TestProd",
                    "Status": "To Do",
                    "Summary": "Hire managers DO NOT DELETE OR MOVE"
                },
                {
                    "Assignee": "",
                    "Attachments": [],
                    "Components": [],
                    "Created": "2023-02-02T16:44:38.839+0200",
                    "Creator": "Example User(example@example.com)",
                    "Description": "",
                    "DueDate": "",
                    "Id": "21427",
                    "Key": "TSTPRD-2",
                    "Labels": [],
                    "LastSeen": "2023-05-07T19:37:42.323+0300",
                    "LastUpdate": "2023-05-07T19:11:33.460+0300",
                    "Priority": "Medium",
                    "ProjectName": "TestProd",
                    "Status": "To Do",
                    "Summary": "Build UI DO NOT DELETE OR MOVE"
                },
                {
                    "Assignee": "",
                    "Attachments": [],
                    "Components": [],
                    "Created": "2023-02-02T16:45:37.346+0200",
                    "Creator": "Example User(example@example.com)",
                    "Description": "",
                    "DueDate": "",
                    "Id": "21429",
                    "Key": "TSTPRD-4",
                    "Labels": [],
                    "LastSeen": "2023-05-04T20:45:40.938+0300",
                    "LastUpdate": "2023-05-04T21:03:30.876+0300",
                    "Priority": "Medium",
                    "ProjectName": "TestProd",
                    "Status": "To Do",
                    "Summary": "Build testing env"
                }
            ],
            "boardId": "12",
            "sprintId": "4"
        }
    }
}

Human Readable Output

Sprint Issues in board 12

Assignee	Created	Creator	Description	DueDate	Id	IssueType	Key	Labels	Priority	ProjectName	Reporter	Status	Summary	TicketLink
	2023-02-02T17:59:21.527+0200	Example User(example@example.com)	Please finish this ASAP.		21430	Story	TSTPRD-5		Medium	TestProd	Example User(example@example.com)	To Do	Hire managers DO NOT DELETE OR MOVE	https://api.atlassian.com/ex/jira/1234/rest/agile/1.0/issue/21430
	2023-02-02T16:44:38.839+0200	Example User(example@example.com)			21427	Task	TSTPRD-2		Medium	TestProd	Example User(example@example.com)	To Do	Build UI DO NOT DELETE OR MOVE	https://api.atlassian.com/ex/jira/1234/rest/agile/1.0/issue/21427
	2023-02-02T16:45:37.346+0200	Example User(example@example.com)			21429	Task	TSTPRD-4		Medium	TestProd	Example User(example@example.com)	To Do	Build testing env	https://api.atlassian.com/ex/jira/1234/rest/agile/1.0/issue/21429

jira-sprint-issue-move

Moves issues to a sprint, for a given sprint ID. Issues can only be moved to open or active sprints. At most 50 issues may be moved at once.

Scope: write:sprint:jira-software

Base Command

jira-sprint-issue-move

Input

Context Output

There is no context output for this command.

Command example

!jira-sprint-issue-move issues=TSTPRD-4 sprint_id=4

Human Readable Output

Issues were moved to the Sprint successfully

jira-user-group-search

Gets users and groups that match a query string.

Scope: read:jira-work

Base Command

jira-user-group-search

Input

Context Output

Command example

!jira-user-group-search query="query"

Context Example

{
  "groups": {
    "groups": [
      {
        "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
        "html": "<b>j</b>dog-developers",
        "name": "jdog-developers"
      },
      {
        "groupId": "6e87dc72-4f1f-421f-9382-2fee8b652487",
        "html": "<b>j</b>uvenal-bot",
        "name": "juvenal-bot"
      }
    ],
    "header": "Showing 20 of 25 matching groups",
    "total": 25
  },
  "users": {
    "header": "Showing 20 of 25 matching users",
    "total": 25,
    "users": [
      {
        "accountId": "5b10a2844c20165700ede21g",
        "accountType": "atlassian",
        "avatarUrl": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
        "displayName": "Mia Krystof",
        "html": "<strong>Mi</strong>a Krystof - <strong>mi</strong>a@example.com (<strong>mi</strong>a)",
        "key": "mia",
        "name": "mia"
      }
    ]
  }
}

Human Readable Output

Users

Account ID	Display Name	Account Type
5b10a2844c20165700ede21g	Mia Krystof	atlassian

Groups

Group ID	Name
276f955c-63d7-42c8-9520-92d01dca0625	jdog-developers
6e87dc72-4f1f-421f-9382-2fee8b652487	juvenal-bot

jira-epic-issue-list

Get all issues that belong to an epic (Child Issues).

Scopes: read:epic:jira-software, read:issue-details:jira, read:jql:jira

Base Command

jira-epic-issue-list

Input

Context Output

Command example

!jira-epic-issue-list epic_key=PROJECTKEY-1 jql_query="status!=done"

Context Example

{
    "Jira": {
        "EpicIssues": {
            "Ticket": [
                {
                    "Assignee": "",
                    "Attachments": [
                        {
                            "created": "2023-01-22T16:43:29.878+0200",
                            "filename": "Screen Shot 2022-10-19 at 20.09.46.png",
                            "id": "16387",
                            "size": 450738
                        },
                        {
                            "created": "2023-02-05T21:11:43.429+0200",
                            "filename": "stam.png",
                            "id": "16399",
                            "size": 450738
                        }
                    ],
                    "Components": [],
                    "Created": "2023-01-03T10:25:17.257+0200",
                    "Creator": "Example User(example@example.com)",
                    "Description": "This issue is for creating the home page.",
                    "DueDate": "",
                    "Id": "21361",
                    "Key": "PROJECTKEY-2",
                    "Labels": [
                        "Demisto",
                        "testnow"
                    ],
                    "LastSeen": "",
                    "LastUpdate": "2023-02-26T18:24:04.172+0200",
                    "Priority": "Medium",
                    "ProjectName": "Company Snoozing App",
                    "Status": "Selected for Development",
                    "Summary": "Create Home Page (including the log in option)"
                },
                {
                    "Assignee": "",
                    "Attachments": [
                        {
                            "created": "2023-03-08T21:04:02.570+0200",
                            "filename": "DemistoContent-InstallContentEnvironment-160822-0023-68.pdf",
                            "id": "16401",
                            "size": 17815
                        },
                        {
                            "created": "2023-03-08T21:03:37.418+0200",
                            "filename": "Screen_Shot_2022-10-19_at_20.09.46 (2).png",
                            "id": "16400",
                            "size": 450738
                        }
                    ],
                    "Components": [
                        "comp2",
                        "Integration"
                    ],
                    "Created": "2023-03-07T17:31:48.225+0200",
                    "Creator": "Example User(example@example.com)",
                    "Description": "Dummy child description",
                    "DueDate": "",
                    "Id": "21496",
                    "Key": "PROJECTKEY-39",
                    "Labels": [
                        "Demisto",
                        "testnow"
                    ],
                    "LastSeen": "",
                    "LastUpdate": "2023-05-04T21:46:22.076+0300",
                    "Priority": "Medium",
                    "ProjectName": "Company Snoozing App",
                    "Status": "Selected for Development",
                    "Summary": "Dummy child issue - delete later"
                }
            ],
            "epicId": "21360"
        }
    }
}

Human Readable Output

Child Issues in epic PROJECTKEY-1

Assignee	Created	Creator	Description	DueDate	Id	IssueType	Key	Labels	Priority	ProjectName	Reporter	Status	Summary	TicketLink
	2023-01-03T10:25:17.257+0200	Example User(example@example.com)	This issue is for creating the home page.		21361	Story	PROJECTKEY-2	Demisto, testnow	Medium	Company Snoozing App	Example User(example@example.com)	Selected for Development	Create Home Page (including the log in option)	https://api.atlassian.com/ex/jira/1234/rest/agile/1.0/issue/21361
	2023-03-07T17:31:48.225+0200	Example User(example@example.com)	Dummy child description		21496	Task	PROJECTKEY-39	Demisto, testnow	Medium	Company Snoozing App	Example User(example@example.com)	Selected for Development	Dummy child issue - delete later	https://api.atlassian.com/ex/jira/1234/rest/agile/1.0/issue/21496

jira-issue-link-type-get

Returns a list of all issue link types.

Scope: read:jira-work

Base Command

jira-issue-link-type-get

Input

There are no input arguments for this command.

Context Output

Command example

#### Context Example

```json
{
    "Jira": {
        "IssueLinkType": [
            {
                "id": "10000",
                "inward": "is blocked by",
                "name": "Blocks",
                "outward": "blocks",
                "self": "https://api.atlassian.com/ex/jira/1234/rest/api/3/issueLinkType/10000"
            },
            {
                "id": "10001",
                "inward": "is cloned by",
                "name": "Cloners",
                "outward": "clones",
                "self": "https://api.atlassian.com/ex/jira/1234/rest/api/3/issueLinkType/10001"
            },
            {
                "id": "10002",
                "inward": "is duplicated by",
                "name": "Duplicate",
                "outward": "duplicates",
                "self": "https://api.atlassian.com/ex/jira/1234/rest/api/3/issueLinkType/10002"
            },
            {
                "id": "10202",
                "inward": "is reviewed by",
                "name": "Post-Incident Reviews",
                "outward": "reviews",
                "self": "https://api.atlassian.com/ex/jira/1234/rest/api/3/issueLinkType/10202"
            },
            {
                "id": "10201",
                "inward": "is caused by",
                "name": "Problem/Incident",
                "outward": "causes",
                "self": "https://api.atlassian.com/ex/jira/1234/rest/api/3/issueLinkType/10201"
            },
            {
                "id": "10003",
                "inward": "relates to",
                "name": "Relates",
                "outward": "relates to",
                "self": "https://api.atlassian.com/ex/jira/1234/rest/api/3/issueLinkType/10003"
            }
        ]
    }
}

Human Readable Output

Issue Link Types

ID	Inward	Name	Outward
10000	is blocked by	Blocks	blocks
10001	is cloned by	Cloners	clones
10002	is duplicated by	Duplicate	duplicates
10202	is reviewed by	Post-Incident Reviews	reviews
10201	is caused by	Problem/Incident	causes
10003	relates to	Relates	relates to

jira-issue-to-issue-link

Use this command to create a link between two issues.

Scope: write:jira-work

Base Command

jira-issue-to-issue-link

Input

Context Output

There is no context output for this command.

Command example

!jira-issue-to-issue-link inward_issue=PROJECTKEY-31 outward_issue=XSOAR-19 link_type="Post-Incident Reviews" comment="Dummy Link"

Human Readable Output

Issue link created successfully

fetch-incidents

Dummy fetch

Base Command

fetch-incidents

Input

There are no input arguments for this command.

Context Output

There is no context output for this command.

get-remote-data

Get remote data from a remote incident. This method does not update the current incident, and should be used for debugging purposes only.

Base Command

get-remote-data

Input

Context Output

There is no context output for this command.

get-mapping-fields

Returns the list of fields to map in outgoing mirroring. This command is only used for debugging purposes.

Base Command

get-mapping-fields

Input

There are no input arguments for this command.

Context Output

There is no context output for this command.

get-modified-remote-data

Get the list of incidents that were modified since the last update time. This method is used for debugging purposes. The get-modified-remote-data command is used as part of the Mirroring feature that was introduced in Cortex XSOAR version 6.1.

Base Command

get-modified-remote-data

Input

Context Output

There is no context output for this command.

update-remote-system

Updates the remote incident with local incident changes. This method is only used for debugging purposes and will not update the current incident.

Base Command

update-remote-system

Input

There are no input arguments for this command.

Context Output

There is no context output for this command.

jira-get-user-info

Retrieves information about a specified Jira user. For on-prem instances, you should use the user’s key and username to retrieve their details. For Cloud instances, user’s account_id is required. If no identifier is supplied, information for the user the API credentials belong to is returned.

Base Command

jira-get-user-info

Input

Context Output

Command example

!jira-get-user-info key=JIRAUSER10000

Context Example

{
    "Active": true,
    "Deleted": false,
    "Display Name": "John Doe",
    "Email": "johndoe@example.com",
    "Key": "JIRAUSER10000",
    "Locale": "en_US",
    "Name": "johndoe",
    "Timezone": "America/Detroit"
}