For the complete documentation index, see llms.txt. This page is also available as Markdown.

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.

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

1

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.

2

Configure the Collect Rule Source

  • Set a Display Name, such as my-org-atlassian-audit.

3

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 settingsAPI 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.

4

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.

5

Review and Create

Review your Collect Rule settings on the Final Review screen.

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.

Create an Index Rule

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

Last updated

Was this helpful?