Atlassian Source
The Atlassian Organizations API provides resources for managing an Atlassian organization, with this API, you can get an audit log of events from organizations. This integration collects that data from the Atlassian Organizations API and ingests them into Sumo Logic.
Data collected
Polling Interval | Data |
---|---|
1 hour | Events |
Setup
::: You need to have Atlassian Guard Premium or Cloud Enterprise plan to access user-created activities. :::
Vendor configuration
Follow the below steps to generate a Bearer access for user configuration:
- Log in to your Atlassian admin console.
- After logging in, navigate to the Organizations tab.
- Go to Settings and select API keys.
- Click on Create API key in the top right.
- Enter a name for the API key.
- Configure the expiration date for the key or leave the default value as 1 week.
- Click on Create and save the API key.
- Copy the values of Organization ID and API key.
- Select Done.
Source configuration
When you create an Atlassian Source, you add it to a Hosted Collector. Before creating the Source, identify the Hosted Collector you want to use or create a new Hosted Collector. For instructions, see Configure a Hosted Collector and Source.
To configure an Atlassian Source:
- Classic UI. In the main Sumo Logic menu, select Manage Data > Collection > Collection.
New UI. In the Sumo Logic top menu select Configuration, and then under Data Collection select Collection. You can also click the Go To... menu at the top of the screen and select Collection. - On the Collection page, click Add Source next to a Hosted Collector.
- Search for and select Atlassian.
- Enter a Name for the Source. The description is optional.
- (Optional) For Source Category, enter any string to tag the output collected from the Source. Category metadata is stored in a searchable field called
_sourceCategory
. - (Optional) Fields. Click the +Add button to define the fields you want to associate. Each field needs a name (key) and value.
- A green circle with a check mark is shown when the field exists in the Fields table schema.
- An orange triangle with an exclamation point is shown when the field doesn't exist in the Fields table schema. In this case, an option to automatically add the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo Logic that does not exist in the Fields schema it is ignored, known as dropped.
- Organizations. Click the +Add button to enter the Organizations you want to associate. Each Organizations needs a API Key value. This is the value that you generated from the Atlassian platform.
The authorization will fail if the API key value used is expired. To re-generate the API key, follow the steps mentioned in vendor configuration.
- (Optional) The Polling Interval is set for 1 hour by default. You can adjust it based on your needs.
- (Optional) Processing Rules for Logs. Configure any desired filters, such as allowlist, denylist, hash, or mask, as described in Create a Processing Rule.
- When you are finished configuring the Source, click Save.
JSON Configuration
Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See Use JSON to Configure Sources for details.
Parameter | Type | Value | Required | Description |
---|---|---|---|---|
schemaRef | JSON Object | {"type":"Atlassian"} | Yes | Define the specific schema type. |
sourceType | String | "Universal" | Yes | Type of source. |
config | JSON Object | Configuration object | Yes | Source type specific values. |
Configuration Object
Parameter | Type | Required | Default | Description | Example |
---|---|---|---|---|---|
name | String | Yes | null | Type a desired name of the source. The name must be unique per Collector. This value is assigned to the metadata field _source . | "mySource" |
description | String | No | null | Type a description of the source. | "Testing source" |
category | String | No | null | Type a category of the source. This value is assigned to the metadata field _sourceCategory . See best practices for details. | "mySource/test" |
fields | JSON Object | No | null | JSON map of key-value fields (metadata) to apply to the Collector or Source. Use the boolean field _siemForward to enable forwarding to SIEM. | {"_siemForward": false, "fieldA": "valueA"} |
pollingInterval | String | No | 1 hour | This sets how often the Source checks for data. | 1 Hour |
orgID | String | Yes | null | ID of the organisation. | |
token | String | Yes | null | Client authentication Bearer token per organization. |
JSON example
{
"api.version": "v1",
"source": {
"config": {
"name": "Atlassian Test",
"fields": {
"_siemForward": true
},
"pollingInterval": "1h",
"organizations": [
{
"orgID": "**************",
"token": "*******"
}
]
},
"schemaRef": {
"type": "Atlassian"
},
"state": {
"state": "Collecting"
},
"sourceType": "Universal"
}
}
Terraform example
resource "sumologic_cloud_to_cloud_source" "Atlassian_source" {
collector_id = sumologic_collector.collector.id
schema_ref = {
type = "Atlassian"
}
config = jsonencode({
"name": "Atlassian Test",
"fields": {
"_siemForward": true
},
"pollingInterval": "1h",
"organizations": [
{
"orgID": "**************",
"token": "*******"
}
]
})
}
resource "sumologic_collector" "collector" {
name = "my-collector"
description = "Just testing this"
}
FAQ
Click here for more information about Cloud-to-Cloud sources.