# Atlassian Admin

> Connect your Atlassian organisation to Tidal Control with an API key, so compliance tests read organisation-level settings and user administration. Read-only.

Source: https://tidalcontrol.com/docs/integrations/atlassian-admin

The Atlassian Admin integration enables Tidal Control to automatically execute compliance tests on your Atlassian organisation via an API key configuration.

Atlassian Admin is used for central management of Atlassian products, allowing administrators to manage users, groups, security policies and compliance settings.

## Requirements

- Super User role in Tidal Control
- Atlassian Admin account with organisation management rights
- Access to Atlassian Admin portal
- API key creation permissions

## Configuration step-by-step plan

We'll create an **Atlassian Admin API key with scopes** in your Atlassian organisation that allows Tidal to retrieve compliance data. A scoped API key is an Atlassian mechanism that enables external applications (Tidal) to securely access specific organisation resources with limited rights.

**Configuration steps:**

1. **Create API key with scopes**
2. **Complete integration**

## Step 1: Create API key with scopes

- Go to **Atlassian Admin portal** at http://admin.atlassian.com
- **Select your organisation** from available organisations
- Click **"Settings"** in top navigation bar
- Select **"API Keys"** in left menu
- Click **"Create API Key"** top right

**Select API key type:**
- Select **"API key with scopes"**
- Click **"Next"**

**API key configuration:**
- **Descriptive name:** `Tidal Control Integration`
- **Expiry date:** Select desired validity period (max. 1 year)
- Click **"Next"**

**Assign scopes:**
Select the following scopes in the **"Read"** section:
- `Classification levels`
- `Domains`
- `Policies`
- Click **"Next"**

**Complete API key:**
- Check API key details
- Click **"Create API Key"**
- **Copy API key value** immediately (no longer visible after closing)
- Click **"Done"**

> **info:**

**API key validity:** Atlassian Admin API keys have a maximum validity period of one year. When your API key expires, Tidal Control can no longer retrieve data from your Atlassian Admin environment.

## Step 2: Complete integration

- Go to **Settings → Integrations** in Tidal Control
- Click the **plus icon** next to Atlassian Admin
- Fill in configuration:
  - **Name:** `Atlassian Admin Production`
  - **API Key:** Copied API key value (from step 1)
- Click **"Create"** to save integration

## Setup for multiple organisations

If you need to connect multiple Atlassian organisations to Tidal Control:

1. **Repeat API key creation** for each Atlassian organisation
2. **Configure separate integration** in Tidal per organisation
3. **Use descriptive names** to distinguish organisations (e.g. "Atlassian Admin EU", "Atlassian Admin US")

## Verification

After successful configuration, Settings → Integrations shows Atlassian Admin under **Configured Integrations**, Atlassian-specific tests are available in the Tests section, and test refreshes deliver results without authentication errors.

> **warning:**

**Save API key:** Note the API key securely - it's no longer visible after creation and uniquely needed for troubleshooting

## Troubleshooting

If the integration does not connect, check the following:

- Verify that API key is correctly copied (no extra spaces)
- Check API key expiry date has not been reached
- Confirm correct permissions selected (Classification levels, Domains, Policies)
- Verify that Atlassian Admin account has organisation management rights

**For more information about Atlassian Admin API management:**
See [official Atlassian documentation](https://support.atlassian.com/organization-administration/docs/manage-an-organization-with-the-admin-apis/)

### Still can't figure it out?

Send an email to support@tidalcontrol.com, and we'll get back to you as soon as possible.

> **info:**

**Gathering support info:** Note which browser you're using, exact error messages, which steps you've already tried, and screenshots of the problem. This significantly speeds up the solution.