Skip to main content

Prerequisites

Install Requirements​

note

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

Before configuring the Atlassian connector, ensure you have:

  • An active Atlassian Cloud subscription
  • Administrator access to your Atlassian organization

Connection Requirements​

Required Configuration Parameters​

ParameterDescriptionHow to Obtain
Site URLThe HTTPS API URL of your Atlassian Cloud instance (e.g., https://admin.yourorg.atlassian.net)Available in your Atlassian admin console
SCIM URLThe SCIM endpoint URL for user provisioning (e.g., https://api.atlassian.com/scim/directory/{directoryId})Generated during directory setup. Click here to know more
Account Security API KeyAuthentication token for API accessGenerated through Atlassian admin portal. Click here to know more.
Admin EmailService account email address with administrator permissionsCreated during service account setup. Click here
Directory IDUnique identifier for your Atlassian directoryGenerated during directory setup. Click here to know more
Directory API KeyAuthentication key for directory accessGenerated during directory setup. Click here to know more
Default Group NamesDefault groups for Jira and Confluence accessConfigurable in Atlassian. Click here to know more

Atlassian Service Account Creation​

To enable IDHub to manage users and groups in Atlassian, a service account with appropriate permissions is required.

Step-by-Step: Creating an Atlassian Service Account​

  1. Log in to http://admin.atlassian.com
  2. Select your organization if you have more than one.
  3. Navigate to Users.
  4. Click Invite user.
  5. Use an admin email that will act as the service account (preferably a dedicated, non-personal email).
  6. Assign the following roles to the service account:
  • Organization Admin or Site Administrator
  • Product Admin (for managing specific Atlassian products like Jira and Confluence).
  1. Confirm the account creation and verify email notifications if needed.

Permission Settings​

If you already have a service account which you would like to connect IDHub to Atlassian, then it must have the necessary permissions to perform provisioning and reconciliation tasks.

Required Permissions​

  • Organization Admin: Allows access to manage users, groups, and directory configurations.
  • Product Admin: Required for managing groups, permissions, and settings in Jira and Confluence.

Note: These permissions are essential for the service account to perform SCIM operations like creating, updating, or deactivating users. Missing any of these permissions may result in errors during provisioning.

Default Group Configuration​

IDHub assigns users to default groups upon provisioning based on your Atlassian setup. Ensure that the groups are correctly configured in IDHub to match your Atlassian environment:

  • Jira Software Default Group: Example: jira-software-users
  • Confluence Software Default Group: Example: confluence-users

To modify default group settings:

  1. Log in to http://admin.atlassian.com .
  2. Select your organization if you have more than one.
  3. Click on Products at the top
  4. Select Manage product for the product you want to check the default group for.
  5. Confirm the group names match those configured in IDHub.

Obtaining Connection Parameters​

1. Generate Account Security API Key​

  1. Log in to admin.atlassian.com as the service account with the appropriate permissions
  2. Click on your profile picture → " Account Settings"
  3. Navigate to "Security" → "Create and manage API tokens"
  4. Click "Create API token"
  5. From the dialog that appears, enter a memorable and concise Label for e.g "IDHub Integration" for your token
  6. Click "Create"
  7. Copy and securely store the generated token
Critical

This token will only be shown once. Store it securely somewhere

2. SCIM URL and Directory ID & API Key Generation​

  • Go to http://admin.atlassian.com .
  • Select your organization if you have more than one.
  • Select Security > Identity providers.
  • Choose the Other Providers.
  • Enter the directory name.
  • Click on Setup User Provisioning
  • In the next step, it will give you the SCIM base URL

  • You will get the DirectoryID from SCIM base url.
    • The SCIM base url would be in the format : https://api.atlassian.com/scim/directory/{directoryId}
    • The {directoryId} part in the SCIM base URL would be your Directory ID
  • The API key generated here will be your Directory API key.
tip

Copy the SCIM URL, API key and the Directory ID to safe place.

Additional Resources​