Skip to main content

Pre-Requisites

Install Requirements​

note

This is specific to Self Hosted deployments. For Sath hosted connectors, these requirements are already in place.

  • You need to install Helm version 3 or above.
  • You can use Kubernetes cluster (1.26 or above) to install the connector

Connection Requirements​

Below is needed to connect to Atlassian

  • An active Atlassian Subscription
  • Site URL - This is the HTTPs API URL of the Atlassian cloud instance purchased. E.g. https://admin.abc.com where abc is the organization domain.
  • Administrator Information - This is for user authentication management. It is to be noted that organization admin and site administrator permission is needed for this account to perform provisioning and reconciliation operations. To manage API tokens in your Atlassian account, read there documentation here.
    • Account Security API Key - This is the token information to be provided at time of configuration
    • Admin Email - This is the email address with required permissions to be created/used as service account
  • Identity Provider Information - Currently IDHub uses identity provider based account management. This helps user management via directory. Below are items required from directory setup. To setup new directory, go to next section of the page.
    • Directory ID
    • Directory API Key
  • Default Groups - IDHub uses default groups provided by Atlassian to provision product access to users. In case you have a different default group than the one provided by Atlassian, that can be entered in the configurations.Below are groups that can be mentioned in the configuration.
    • Jira Software Default Group Name
    • Confluence Software Default Group Name

Directory Setup​

The steps for getting Directory ID and creating the API key are as follows:

  1. Go to admin.atlassian.com. Select your organization if you have more than one.
  2. Select Settings > API keys.
  3. Select Create API key in the top right.
  4. Enter a name that you’ll remember to identify the API key.
  5. By default, the key expires one week from today. If you’d like to change the expiration date, pick a new date under Expires on. You’re unable to select a date longer than a year from the date of creation.
  6. Select Create to save the API key.
  7. Copy the values for your Organization ID and API key. You'll need those to use the API key. Note: Make sure you store these values in a safe place, as we won't show them to you again.
  8. Select Done. The key will appear in your list of API keys.

Permissions​

  • The service account needs to be an organization admin and site administrator to manage the users and groups found in your atlassian directory. For more information check official atlassian documentation here

  • To fully manage atlassian groups and apps, the service account needs to be product admin as well. For more information regarding default groups and permissions, check official atlassian documentation here