Prerequisites

• Configure at least one virtual appliance cluster and successfully test the connection. For instructions, refer to the Virtual Appliance Reference Guide.

• A Service account that is a member of the Jira administrators group is required for basic authentication and Personal Access Token authentication.

• All Atlassian products that you want to be managed using this connector must be connected to a single Jira server for centralized user management.

• For Atlassian Data Center version 10.x, a server with SFTP access must be set up to allow connections for transferring files required for account aggregation.

Basic Authentication

The service account is authorized using Basic Authentication, which requires a username and password. It is generated by a user account with Administrator access. A service account that is a member of the Jira administrators group is required for Basic Authentication.

Personal Access Token Authentication

The service account is authorized using Personal Access Token (PAT) authentication. The token is encoded and generated by a user account with Administrator access. It is then added to the headers for API requests.

To enable the Auto Refresh Personal Access Token, the authentication type must be set to Personal Access Token. 

Creating a Personal Access Token

1. In Jira, select your profile picture at the top right corner of the screen.

2. Select Profile.

3. Select Personal Access Tokens from the left-hand menu.

4. Select Create Token.

5. Give your new token a name.

SFTP based Account Aggregation

From Atlassian Data Center version 10.x onwards, the API-based user aggregation method is no longer supported.

To enable account aggregation, an SFTP based setup is required. This requires uploading a CSV file containing user details, extracted from the Atlassian database to the SFTP server.

Important
When exporting CSV files, use UTF-8 without BOM encoding.

Steps for File Based Account Aggregation (Data Center 10.X Onwards Only)

1. Set Up a SFTP host.

2. Create an Access-Controlled Folder.

3. Extract User Details from Atlassian Data Center’s Database.

   Note
   The Extracted file must have user_name, display_name, email_address, active. The column names must match these exactly to work correctly.

4. Use the following MySQL query to extract the required user details:

   Copy

   SELECT  'user_name' , 'display_name', 'email_address', 'active'
   UNION ALL 
   SELECT u.user_name, u.display_name, u.email_address, 
    CASE 
          WHEN u.active = 1 THEN 1
           WHEN u.active = 0 THEN 0
           WHEN u.active = 'Active' THEN 1
           WHEN u.active = 'Inactive' THEN 0
    END AS active 
   FROM cwd_user u 
   JOIN cwd_directory d ON u.directory_id = d.id  
   INTO OUTFILE '<Absolute Path of above created folder>/<FileName>.csv'
   FIELDS TERMINATED BY ',' 
   ENCLOSED BY '"' 
   LINES TERMINATED BY '\n';

5. Configure the file path and SFTP Connection Credentials in Aggregation Settings.