Skip to main content

Atlassian

Updated

Overview

This page describes the steps to integrate Atlassian from the App Catalog page in Josys.
Using JIRA is required to use the integration feature.
JIRA is also required for integrating Confluence or Statuspage.

As a known issue on the Atlassian side, deleting user accounts with comments or assignments is not supported.
Reference: https://jira.atlassian.com/browse/JRACLOUD-82526

Integration Specifications

Target Plans Only Atlassian Cloud can be integrated (Atlassian Server and Atlassian Data Center are not supported)
Admin Type for Integration Organization Admin
Integration Method API Key/Token
Integration Key Email (or Basic Info > Atlassian Account ID)
Supported Features Account Deletion* Account Discovery Account Provisioning License Discovery
Status Excluded from Unmanaged IDs Deleted
Available Settings on Provisioning Group Settings
Available Settings on Deletion
Contract Information How to check contract details
Other Retrieved Items Groups

Visible Items

 • Licenses
• Last Active Date/Time
• Role
• Status
• Groups
Retrieved Items for License Management User licenses
Common Items Last ActiveRole Status User
Retrieved Roles • Site admin
• Product admin
Role Editing
Target Accounts Includes guests

Prerequisites

  1. In the Global Permissions settings in JIRA, please confirm that you belong to a group with the Browse users and groups permission.
  2. If necessary, add the relevant group from the "Grant permission" section at the bottom of the screen.

Generating an API Token

Log in to the Atlassian API token management screen with an Organization Admin account, and go to Manage account ＞ Security ＞ API tokens. Click "Create API token" to generate a token. Please save the generated token as it is required to integrate with Josys.

For more details, please refer to the official documentation.

(Optional) Generating an Organization ID and Organization API Key

From a GDPR perspective, user emails are set to private by default in Atlassian's API. Therefore, Atlassian accounts are integrated into Josys without email addresses.

Setting up the Organization ID and Organization API Key is optional, but doing so allows you to retrieve email information for managed accounts, which can be used for automatic user matching.

If you prefer to visualize users without retrieving email addresses using Atlassian's default settings, you do not need to generate them.

💡To retrieve and visualize Atlassian license information, you must configure the Organization ID and Organization API Key.

What are Managed Accounts?

Managed accounts are all Atlassian accounts with email addresses from your verified domains.
For example, if there is an account like yamada.taro@josys.com, verifying the domain josys.com will allow that account to be treated as a "managed account."

For more details, please refer to: What are Atlassian managed accounts?

Steps to Configure Managed Accounts

  1. Please refer to the Atlassian documentation below to verify your domain.
    Verify a domain
  2. Generate the Organization ID and Organization API Key.
  3. Log in to the Atlassian administration screen with an Organization Admin account.
  4. Go to Settings > API keys, click Create API key, select no scopes, and enter a name and expiration date.
    Generate the Organization ID and Organization API Key.


Integrating Atlassian

  1. Click "Integrations ＞ App Catalog" from the left sidebar of Josys.
  2. Search for and click Atlassian.
  3. The setup page will be displayed on the right.

  4. On the setup screen, enter the Admin Email, the retrieved API Token, Admin URL, and optionally the Organization ID and Organization API Key, then click Next.
  5. For the Admin URL, enter the URL of the Atlassian site you are logged into (up to ".net").
    Example: https://josys-it.atlassian.net

Alternative Method to Retrieve Email Addresses Without Managed Account Setup

  1. Ask each Atlassian user to update their settings from their profile screen. For more details, please refer to the official documentation.
  2. On the profile screen, set the visibility of Contact > Email address to "Anyone".

Related articles