Atlassian (Formerly Atlassian Jira Software)
Atlassian (formerly Atlassian Jira Software) is a work management tool for various use cases, from requirements and test case management to agile software development.
This adapter lets you fetch data and get visibility and security across all Atlassian accounts and products at your company, including the users managed under the following cloud products:
- Jira Software
- Jira Work Management
- Jira Service Management
- Confluence
- Bitbucket
- Trello
- Opsgenie
Asset Types Fetched
- Users, Roles, Groups, Application Settings, Accounts/Tenants, Application Resources, Permissions
Resources Required by Asset Type
The following connection parameters, advanced settings, permissions, and configurations are required to fetch each asset type.
Search by Asset Type to find the resources required for your specific needs.
Note
To fetch Roles, Groups, Application Settings, and Accounts/Tenants, you must have Axonius SaaS Applications configured in your environment.
Asset Type | Permissions | Additional Configuration | ||
|---|---|---|---|---|
Users |
| No specific advanced setting required |
Permissions for non-admin accounts: see steps 7-8 in Creating a User Account |
|
Roles |
| No specific advanced setting required |
Permissions for non-admin accounts: see steps 7-8 in Creating a User Account | |
Groups |
| Fetch groups |
Permissions for non-admin accounts: see steps 7-8 in Creating a User Account | |
Application Settings |
| Fetch settings |
| |
Accounts/Tenants |
| No specific advanced setting required |
Permissions for non-admin accounts: see steps 7-8 in Creating a User Account | |
Application Resources |
| No specific advanced setting required |
Permissions for non-admin accounts: see steps 7-8 in Creating a User Account | |
Permissions |
| Fetch permissions |
Permissions for non-admin accounts: see steps 7-8 in Creating a User Account |
APIs
Axonius uses the Jira Cloud platform REST API.
Setting Up Atlassian to Work with Axonius
To fetch all asset types, set up the following:
Creating a User Account
Notes
- While to access application data you need to grant roles and/or permissions that include write capabilities, the adapter only actually reads data from the application.
- (Relevant for Application Settings only) If single-sign-on is enabled, it is recommended to derive the username and password from a user account maintained by the single-sign-on solution.
You must have the Jira Administrator or Jira System Administrator global permission to be able to manage users in Jira applications.
To create a new user, from the Atlassian Administration:
-
Navigate to Administration
>User Management. -
In the User browser, select Create User.
-
Enter the Username, Password, Full Name, and Email address.
- The password length should be at least 32 characters.
- The user account needs to have MFA disabled.
-
Select all Jira applications.
-
Select Create.
-
Set admin permissions:
- Go to Settings
>Administrators. - Click Add administrators.
- Enter the created Atlassian account email address and click Grant access.
- Go to Settings
-
To fetch data from Jira if the created account has not been set as an admin: edit that user and add them to groups that provide the following permissions:
- Administer Jira global permission
- Browse users and groups global permission
- Administer projects project permission (for all projects)
-
To fetch data from Confluence if the created account has not been set as an admin: edit that user and add them to groups that provide the following permissions:
- Permission to access the Confluence site ('Can use' global permission)
- 'View' permission for all spaces
Creating an API Token
- Login to admin.atlassian.com with the Atlassian user account you created, and generate an API token, using the following URL:
https://id.atlassian.com/manage/api-tokens# - Select Create API token.
- Select a label that is short and easy to remember, and click Create.
- Copy the generated API token.
- In Axonius, in the Add Connection drawer, paste the copied token in the API Token field.
Creating an Organization API Key
Note
This is only required to fetch organizational information under the Users asset type.
- Login to a_dmin.atlassian.com_ with the Atlassian user account you created.
- Select your organization (if you have more than one).
- Select Settings
>API keys. - Select Create API key on the top right.
- Enter a name that you can easily remember to identify the API key.
- Set the latest date possible for the key expiration date. Usually, the maximum is one year.
- Select Create to save the API key.
- Copy the generated Organization ID and API key.
- Select Done. The key will appear in your list of API keys.
- In Axonius, paste the copied values in the Atlassian Admin API - API Key and Atlassian Admin API - Organization ID fields.
Connecting the Adapter in Axonius
To connect the adapter in Axonius, provide the following parameters:
Required Parameters - All Asset Types
- Domain - The hostname or IP address of the Jira Software server.
- User Name - The username for a user account that has the required permissions to fetch assets.
- API Token - An API Token associated with a user account that has the required permissions to fetch assets. Note: The API Token is not the same as the Admin Key.
- Jira API Version (default: V3) - Select your Jira API version.
Required Parameters - Application Settings
- Password - The password for the Atlassian user account.
- 2FA Secret Key - If your organization requires two-factor authentication to access Atlassian, and you want to fetch Application Settings from Atlassian, you will need to generate a secret key in a 2FA solution such as Google authenticator and paste it here. See for example Set Up Google Authenticator in the Okta adapter documentation.
Required Parameters - Fetching Users Organizational Data
Atlassian Admin API - Organization ID and Atlassian Admin API - API key
Optional Parameters
The following parameters are optional:
- Verify SSL - Select whether to verify the SSL certificate of the server against the CA database inside of Axonius. For more details, see SSL Trust & CA Settings.
- HTTPS Proxy - Connect the adapter to a proxy instead of directly connecting it to the domain.
To learn more about common adapter connection parameters and buttons, see Adding a New Adapter Connection.
Advanced Settings
Note
Advanced settings can either apply to all connections for this adapter, or to a specific connection. Refer to Advanced Configuration for Adapters.
- Do not fetch disabled users (required, default: false) - Select whether to exclude fetching disabled users or not.
- Distinguish User ID From Different Domains - When selected, the Atlassian domain is appended to the ID of each user, to allow Axonius to fetch the same users from multiple sites without overriding the data.
- Users per page (default: 50) - Enter the number of users listed per a single request. Atlassian might limit the maximum number of users per page. If the number you enter is higher than the limit, the fetch will fail. Therefore make sure the value you enter is lower than that.
Note
The following Advanced Settings are available only for customers who have Axonius SaaS Applications enabled.
- Fetch projects and project roles - Select this option to fetch projects and project roles.
- Fetch groups - Select to fetch users groups details.
- Fetch permissions - Select to fetch permissions configured for the Atlassian accounts in your organization.
- Fetch settings - Select to fetch settings configured for the Atlassian accounts in your organization.
- Filter users without site access - Select to exclude users who cannot access the Atlassian site.
- Number of parallel requests - Specify the maximum parallel request this adapter will create when connecting the Atlassian server. This setting lets you control the performance of this adapter.
Note
To learn more about Adapter Configuration tab advanced settings, see Adapter Advanced Settings.
Related Enforcement Actions
Version Matrix
This adapter was only tested with the versions marked as supported, but may work with other versions. Contact Axonius Support if you have a version that is not listed, which is not functioning as expected.
| Version | Supported | Notes |
|---|---|---|
| V3 | Yes | -- |
Updated 1 day ago
