> ## Documentation Index
> Fetch the complete documentation index at: https://koreai.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Jira connector
[Back to the list of Connectors](/agent-platform/knowledge#connectors)
Connect Jira Cloud to Artemis to ingest Jira issues into your knowledge base. The connector supports filtering by project, issue metadata, and modification date, with optional ingestion of issue comments. It also supports Jira permission-aware access control (ACL) to ensure users only retrieve content they are authorized to access.
| **Specification** | **Details** |
| -------------------- | ------------------------------------------------------------------ |
| Repository type | Cloud |
| Supported content | Issues and Comments, Attachments, Worklogs related to Issues. |
| Content filtering | Yes |
| Permission-aware ACL | Yes |
| Attachment formats | PDF, DOCX, TXT, Markdown, HTML, CSV, JPG/JPEG, PNG, XLSX, and JSON |
## Prerequisites
Before configuring the connector, ensure you have:
* Administrator access to the Jira Cloud site.
* A Jira OAuth application or supported authentication credentials.
* A configured Jira Authentication Profile in the platform.
* Access to the Jira projects that you want to ingest.
## Configure the Jira connector
## Connection Settings
Use the **Connect a Jira Cloud Site** section to establish the connection.
| **Field** | **Description** |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Jira auth profile** | Select an existing Jira authentication profile. Click **New auth profile** to create one if required. |
| **Auth type** | Authentication mechanism associated with the selected authentication profile. The Jira connector supports three types of authentication: Basic, Bearer Token, and OAuth.
For details on creating an OAuth app in Atlassian, see [Create OAuth 2.0 (3LO) apps](https://developer.atlassian.com/cloud/jira/software/oauth-2-3lo-apps/). The required scopes and callback URLs are provided in the Artemis authentication profile creation UI. |
| **Jira site URL** | URL of your Jira Cloud instance. Example: `https://company.atlassian.net`. |
| **Discovered Jira site** | Automatically discovers and lists Jira sites associated with the selected authentication profile. |
## Projects and filters
Use this section to limit the scope of content ingestion.
| **Field** | **Description** |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Project keys** | Comma-separated list of Jira project keys to ingest. Only issues from these projects are synchronized. In **Jira**, a **project key** is a short, unique identifier assigned to a project. It forms the prefix of every issue ID in that project. |
| **Issue types** | Restrict synchronization to specific issue types such as Bug, Story, or Task. |
| **Statuses** | Synchronize only issues with the specified workflow status. |
| **Labels** | Synchronize only issues containing the specified labels. |
| **Modified after** | Synchronize issues updated after the selected date. |
| **Modified before** | Synchronize issues updated before the selected date. |
> **Note:** Project keys define the primary source boundary. Optional filters further reduce the issues that are synchronized.
## Objects and child resources
Choose which Jira objects to synchronize.
| **Option** | **Description** |
| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Issues** | Synchronizes Jira issues, including the summary, description, status, priority, assignee, and reporter fields. |
| **Comments** | Synchronizes comments associated with each issue. |
| **Attachments** | Synchronizes and indexes attachments associated with issues. Supported formats: PDF, DOCX, TXT, Markdown, HTML, CSV, JPG/JPEG, PNG, XLSX, and JSON. |
| **Worklogs** | Synchronizes worklog entries associated with each issue. |
**Note:** Child resources (Comments, Attachments, and Worklogs) are synchronized only when enabled.
## Advanced JQL
Use **Advanced JQL** to define additional Jira Query Language (JQL) filters.
The specified JQL is combined with the selected project scope and optional filters during synchronization.
Example:
```sql theme={null}
assignee = currentUser()
AND priority = High
AND resolution = Unresolved
```
## Permission-aware ACL
Enable **Permission-aware ACL** to preserve Jira access permissions in the search index. When enabled:
* Jira issue visibility is synchronized with the indexed documents.
* Search results are filtered based on each user's Jira permissions.
* The connector fails closed if document visibility cannot be determined.
When available, ACL evidence is projected from Jira entities such as:
* Assignee
* Reporter
* Watchers
Only users associated with an issue through one of the entities listed above can view that issue in search results.
## Review and activate
1. Generate a proposal to review the scope of synchronization.
2. Run a **Dry run** to validate the configuration and preview the synchronized content.
3. Click **Approve & Sync** to activate the connector.