> For the complete documentation index, see [llms.txt](https://docs.scanner.dev/scanner/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.scanner.dev/scanner/using-scanner-complete-feature-reference/data-ingestion/sources/atlassian.md).

# Atlassian

This guide walks through how to set up Atlassian audit logs as a source in Scanner Collect, using direct API integration with the [Atlassian admin org events API](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-events/#api-v1-orgs-orgid-events-stream-get).

We'll assume that you want Scanner to both store the logs in S3 and index them for search and detection.

## Create a Collect Rule

{% stepper %}
{% step %}

### Create a New Source

In the Scanner UI, go to the Collect tab.

* From the Overview page click the '+' icon in the upper right corner
* Select create new **Collect Rule**
* Choose **Atlassian**.
* On the **Select a Log Type** screen, choose **Atlassian: Audit**.
  {% endstep %}

{% step %}

### Configure the Collect Rule Source

* Set a **Display Name**, such as `my-org-atlassian-audit`.
  {% endstep %}

{% step %}

### Authenticate with Atlassian

* If you've previously created an Atlassian connection, select it from the list and skip to the next step.
* Otherwise, select **New Atlassian Connection** and fill in:
  * **Connection Name**: A recognizable name for this connection.
  * **Organization ID**: The UUID of your Atlassian organization (see below).
  * **API Key**: The API key value (see below).

If you already have an Organization ID and API key, paste them into the Scanner connection form. Otherwise, create them in Atlassian:

1. Sign in at `admin.atlassian.com` as an organization admin.
2. Open the organization, then go to **Organization settings** → **API keys**.
3. Click **Create API key**, give it a name (e.g. `scanner-audit-logs`), and grant it access to read audit log events.
4. On the **Copy API key** screen, copy both the **Organization ID** and the **API key**. The API key cannot be recovered after you leave this screen, so save it somewhere safe (e.g. a password manager) before continuing.
5. Paste both values into the Scanner connection form.
   {% endstep %}

{% step %}

### Logs Destination

* Choose the S3 Bucket where the raw Atlassian audit logs should be stored.
* Enter a **Bucket Prefix** (recommended, e.g. `atlassian/audit/`) to organize the data path in your bucket and avoid collisions with other sources.
  {% endstep %}

{% step %}

### Review and Create

Review your Collect Rule settings on the **Final Review** screen.
{% endstep %}
{% endstepper %}

## Create an Index Rule

With the Collect Rule created, Scanner will poll the Atlassian admin org events API every **5 minutes**. New events will be written to your S3 bucket, under the specified prefix.

Create an Index Rule to have Scanner index the logs for fast search and detections.

{% content-ref url="/pages/Gem9jwD4aqayN3OiChpN" %}
[Create an Index Rule](/scanner/using-scanner-complete-feature-reference/data-ingestion/create-an-index-rule.md)
{% endcontent-ref %}

### Atlassian Defaults

When you create the Index Rule from the Collect Rule, the following defaults are pre-populated:

* **Transformations**: Add Metadata, Parse JSON Columns
* **Timestamp Field**: `.attributes.time`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.scanner.dev/scanner/using-scanner-complete-feature-reference/data-ingestion/sources/atlassian.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.