Skip to content
This repository has been archived by the owner on Aug 8, 2024. It is now read-only.

Latest commit

 

History

History
204 lines (161 loc) · 8.75 KB

jupiterone.md

File metadata and controls

204 lines (161 loc) · 8.75 KB
Raw

Jira

Jira + JupiterOne Integration Benefits

  • Visualize Jira projects, users, and issues in the JupiterOne graph.
  • Map Jira users to employees in your JupiterOne account.
  • Monitor Jira issues configured as vulnerabilities or findings within the alerts app.
  • Monitor changes to Jira users, projects, and issues using JupiterOne alerts.
  • Create Jira issues from JupiterOne alerts and monitor progress against those issues in JupiterOne.
  • Create Jira issues from JupiterOne compliance controls that need attention.

How it Works

  • JupiterOne periodically fetches Jira projects, users, and issues* to update the graph.
  • Write JupiterOne queries to review and monitor updates to the graph.
  • Configure alerts to take action when the JupiterOne graph changes.
  • Jira issue entities will have additional _class values when custom types are used in Jira:
    • Change (also added when the issue key starts with PRODCM)
    • Finding
    • Incident
    • Risk
    • Vulnerability

(*) The integration performs a rolling ingestion of up to 2000 of the most recently created or updated issues per project since the last integration execution in Jupiterone. If it is the integration's first run, all issues in each project are fair game for ingestion (up to 2000).

(*) Already ingested issues that are not modified will remain in the graph when the integration runs again. Issues are only deleted along with other entities associated with the integration instance when the integration instance is deleted.

(*) Note that for projects with > 2000 issues, the first run of the integration will not ingest all issues. Nor will they get ingested in subsequent integration runs. If you have a need for all Jira issues to be ingested for a large project, please contact Support.

(*) This integration logs a warning anytime the per-project issue cap is encountered. It is technically possible to encounter this warning on an integration execution other than the first, but it is quite rare (over 2000 issues would have had to have been updated since the last integration execution). If this happens, it is likely your Polling Interval in Jupiterone is too large. We recommend setting it to a smaller value. If you require re-ingestion of missed issue updates as a result of hitting our limits, please contact Support.

(*) Since this integration will ingest the last 2000 recently created/updated issues per project since the last successful integration run, adding new projects to an existing integration configuration is discouraged. If one wishes to ingest additional projects after the creation of an integration configuration, we recommend that a new configuration be created with all the projects one wishes to ingest. Then delete the old integration configuration.

Requirements

  • JupiterOne requires the hostname for your Jira organization. JupiterOne also requires the username/email and an API key for a user having the correct permissions granted.
  • The integration supports Jira Cloud with Jira API v3 and Jira Data Center with Jira API v2. Other setups may work.
  • You must have permission in JupiterOne to install new integrations.

Support

If you need help with this integration, please contact JupiterOne Support.

Integration Walkthrough

Customers authorize access to JupiterOne by creating a Jira user and providing the username and password (or API token when passwords require MFA) to JupiterOne for HTTP Basic Auth as described in the Jira Security for Other Integrations documentation.

In Jira

Configure an User for API Access

Option 1 - Create a New User

  1. Create a new service account for JupiterOne use or use an existing account.
  2. Login to Jira and navigate to User Management.
  3. Send an invite to the service account.

Option 2 - Leverage an Existing User

Before you use an existing user, you should verify a couple of things.

  • Make sure the appropriate permissions are configured/can be added to the account (see the Permissions section below).
  • Make sure you have the ability to login to the user's Jira account.

Permissions

Create an API Token

  1. Log in to Jira as the JupiterOne user and follow the Jira guide to create an API token.

In JupiterOne

  1. From the top navigation of the J1 Search homepage, select Integrations.
  2. Scroll to the Jira integration tile and click it.
  3. Click the Add Configuration button and configure the following settings:
    • Enter the Account Name by which you'd like to identify this Jira account in JupiterOne. Ingested entities will have this value stored in tag.AccountName when Tag with Account Name is checked.
    • Enter a Description that will further assist your team when identifying the integration instance.
    • Select a Polling Interval that you feel is sufficient for your monitoring needs. You may leave this as DISABLED and manually execute the integration.
    • Enter the Hostname of your organization.
    • Enter the User Email used to authenticate with Jira.
    • Enter the API Token in the User Password field.
    • Toggle the Redact Issue Descriptions option if you would like to avoid descriptions on your jira_issue entities
    • Enter the Project Keys that the integration will retrieve data from.
  4. Click Create Configuration once all values are provided.

How to Uninstall

  1. From the top navigation of the J1 Search homepage, select Integrations.
  2. Scroll to the Jira integration tile and click it.
  3. Identify and click the integration to delete.
  4. Click the trash can icon.
  5. Click the Remove button to delete the integration.

Jira Cloud vs Jira On-Prem

This integration supports both Jira Cloud and Jira on-prem deployments and will automatically detect which is being ingested. It is important to note that there are some minor differences in the APIs for cloud and on-prem. For this reason, we recommended that you recreate your integration configuration in the event of an on-prem -> cloud migration or vice versa.

Data Model

Entities

The following entities are created:

Resources Entity _type Entity _class
Account jira_account Account
Jira Issue jira_issue Record, Issue
Jira Project jira_project Project
Jira User jira_user User

Relationships

The following relationships are created:

Source Entity _type Relationship _class Target Entity _type
jira_account HAS jira_project
jira_account HAS jira_user
jira_project HAS jira_issue
jira_user CREATED jira_issue
jira_user REPORTED jira_issue