---
title: Jira
slug: docs/source-jira
description: Learn how to seamlessly integrate TruffleHog with Atlassian Jira. Discover step-by-step instructions for creating Jira Cloud and on-premise Jira credentials, along with essential configuration options for local se
icon: {"faIcon":"fa-brands fa-jira"}
docTags: 
createdAt: 2024-04-17T14:48:39.543Z
---

# Jira

:::BlockQuote
**Edition:** Enterprise only
:::

The Jira integration scans issue descriptions, comments, and attachments in Atlassian Jira for credentials and other sensitive data. To send TruffleHog detections to Jira as notifications, see the Jira notifier instead.

## Configuration

The Jira integration can be configured in TruffleHog under **Integrations**, or via a local configuration file (below).

### Web configuration

Configure this integration from the **Integrations** page in TruffleHog. You'll need credentials appropriate to your Jira deployment — see the local configuration section below for the supported authentication methods.

### Local configuration

Local configuration supports three authentication modes, depending on your Jira deployment:

- **Jira Cloud (basic auth)** — uses your Atlassian email address as the username and a Jira Cloud API token as the password. Jira service accounts are not supported at this time.
- **Jira Server / Data Center (bearer token)** — uses a personal access token (PAT).
- **Jira Server / Data Center (basic auth)** — uses an account username and password.

If projects is omitted, all projects the credentials can list and access are scanned.

**Jira Cloud (basic auth)**

Use this for Jira Cloud. The username must be the email address attached to your Atlassian account, and the password must be a Jira Cloud API token. Standard passwords cannot be used in place of an API token for Jira Cloud.

:::BlockQuote
sources:
  \- connection:
      "@type": type.googleapis.com/sources.JIRA
      endpoint: https\://ourbusiness.atlassian.net
      basicAuth:
        \# Jira Cloud requires an API token for the password.
        username: scanner-account\@ourbusiness.com
        password: XXXXXXXXXXXXXXXXXXXXXXXXXX
    name: JIRA
    scanPeriod: 12h
    type: SOURCE\_TYPE\_JIRA
    verify: true
:::

**Jira Server / Data Center (bearer token)**

Use this for self-hosted Jira with a personal access token.

:::BlockQuote
sources:
  \- connection:
      "@type": type.googleapis.com/sources.JIRA
      endpoint: https\://jira.ourbusiness.com
      token: XXXXXXXXXXXXXXXXXXXXXXXXXX
    name: JIRA
    scanPeriod: 12h
    type: SOURCE\_TYPE\_JIRA
    verify: true
:::

**Jira Server / Data Center (basic auth)**

Use this for self-hosted Jira with username and password authentication.

:::BlockQuote
sources:
  \- connection:
      "@type": type.googleapis.com/sources.JIRA
      endpoint: https\://jira.ourbusiness.com
      basicAuth:
        username: scanner-account\@ourbusiness.com
        password: XXXXXXXXXXXXXXXXXXXXXXXXXX
      projects:
        \- ENG
        \- ITSYS
    name: JIRA
    scanPeriod: 12h
    type: SOURCE\_TYPE\_JIRA
    verify: true
:::

## Configuration options

| Field                 | Type    | Required | Description                                                                       |
| --------------------- | ------- | -------- | --------------------------------------------------------------------------------- |
| endpoint              | string  | Yes      | The URL of the Jira instance.                                                     |
| projects              | list    | No       | Explicit list of project keys to scan. Omit to enumerate instead.                 |
| ignoreProjects        | list    | No       | Project keys to skip during scanning. Combines with enumeration.                  |
| insecureSkipVerifyTls | boolean | No       | Skip TLS certificate verification. Setting this to true may pose security issues. |

## Capabilities

| Feature                  | Supported |
| ------------------------ | --------- |
| Scan issue descriptions  | ✅         |
| Scan comments            | ✅         |
| Scan attachments         | ✅         |
| Scan archive files       | ✅         |
| Scan base64-encoded data | ✅         |
| Scan binaries            | ✅         |
| Auto-resume              | ✅         |