SaaS Security
Onboard an Atlassian App to SSPM
Table of Contents
Onboard an Atlassian App to SSPM
Onboard an Atlassian app to enable third-party plugin scans for Jira and
Confluence.
| Where Can I Use This? | What Do I Need? |
|---|---|
|
Or any of the following licenses that include the Data Security license:
|
For SSPM to detect posture risks in your Atlassian instance, you must onboard your
Atlassian instance to SSPM. Through the onboarding process, SSPM connects to an
Atlassian API and, through the API, scans your Atlassian Administration settings for
your organization. If there are misconfigured settings, SSPM suggests a remediation
action based on best practices.
Some of the Atlassian Administration settings that SSPM
scans affect Jira and Confluence. These are high-level Atlassian Administration
settings for your organization, and will differ depending on whether your
organization has the free, Standard, or Premium versions of these products. To have
SSPM scan settings at the Jira and Confluence level, you must onboard a Jira app and onboard a Confluence app.
If users have extended the capabilities of Jira and Confluence by installing
third-party plugins, SSPM also detects the third-party plugins and the access that
the plugins were granted. This information helps you determine the risks posed by
third-party plugins so you can take action as needed. It is not necessary to onboard
Jira and Confluence to SSPM to enable these third-party plugin scans.
To access your Atlassian instance, SSPM requires the following information, which you
will specify during the onboarding process.
| Item | Description |
|---|---|
| API Token | A token, generated by an Atlassian Org Admin, that enables SSPM to authenticate to the administrator account. |
| API Key | A key, generated by an Atlassian Org Admin, that enables SSPM to scan and update organization settings and user accounts. SSPM uses this key to identify and manage the third-party plugins that users have connected to Jira or Confluence. |
| Admin Email | The login email address of the Atlassian Org Admin who created the API token and API key. |
To onboard your Atlassian instance, you complete the following actions:
- Generate and Copy an Administrator API Token
- Generate and Copy an API Key for Your Organization
- Connect SSPM to Your Atlassian Instance
Generate and Copy an Administrator API Token
- Log in to Atlassian using Org Admin credentials.
- From the Atlassian account profile, navigate to the API tokens page for the account. To do this, select or go directly to this URL: id.atlassian.com/manage-profile/security/api-tokens.
- Create API Token.
A dialog prompts you to specify a label for the API token. - Specify a label and Create the API token.Atlassian generates and displays your new API token.
- Copy the API token and paste it into a text file.Do not continue to the next step unless you have copied the API token. You must provide this token to SSPM during the onboarding process.
Generate and Copy an API Key for Your Organization
To identify and manage the third-party plugins that users have connected to Jira
or Confluence, SSPM requires an API key generated from an administrator
account.
- Log in to the Atlassian Admin Portal using Org Admin credentials.
- If you administer more than one Atlassian organization, select the organization you want SSPM to scan for third-party plugins.
- Select .
- On the API keys page, click Create API key.
- In the Create an API key dialog, specify a name and an expiration date for the key and Create the key.Atlassian generates and displays a new API key.
- Copy the API key and paste it into a text file.Do not continue to the next step unless you have copied the API key. You must provide this key to SSPM during the onboarding process.
Connect SSPM to Your Atlassian Instance
- From the Add Application page (), click the Atlassian tile.
- Under posture security instances, Add Instance or, if there is already an instance configured, Add New instance.
- Choose the option to Log in with Credentials.
- Enter the login email address of the Atlassian administrator who created the API token and the API key.
- Connect.