HelloID-Conn-Prov-Target-Atlassian-Jira

Important

This repository contains the connector and configuration code only. The implementer is responsible to acquire the connection details such as username, password, certificate, etc. You might even need to sign a contract or agreement with the supplier before implementing this connector. Please contact the client's application manager to coordinate the connector requirements.

Table of contents

• HelloID-Conn-Prov-Target-Atlassian-Jira
  • Table of contents
  • Prerequisites
  • Remarks
  • Introduction
  • Getting started
    • Provisioning PowerShell V2 connector
      • Correlation configuration
      • Field mapping
    • Connection settings
  • Setup the connector
    • API token
    • Permissions
  • Getting help
  • HelloID docs

Prerequisites

• HelloID Provisioning agent (cloud or on-prem).
• HelloID environment.
• API token in Atlassian. The following values are needed to connect:
  • Username.
  • Password.

Remarks

• There is no update API available, therefore there is no update action available either.

Introduction

HelloID-Conn-Prov-Target-Atlassian-Jira is a target connector. Atlassian provides a set of REST API's that allow you to programmatically interact with its data. The Atlassian jira connector uses the API endpoints listed in the table below.

Endpoint	Description
/rest/api/3/user	Create user (POST)
/rest/api/3/user	Delete user (DELETE)
/rest/api/3/groups/picker	List groups (GET)
/rest/api/3/group/user	Add member (POST)
/rest/api/3/group/user	Remove member (DELETE)

The following lifecycle actions are available:

Action	Description
create.ps1	Create or correlate to an account
delete.ps1	Delete an account
groups - permissions.ps1	List groups as permissions
groups - grantPermission.ps1	Grant groupmembership to an account
groups - revokePermission.ps1	Revoke groupmembership from an account
configuration.json	Default configuration.json
fieldMapping.json	Default fieldMapping.json

Getting started

By using this connector you will have the ability to seamlessly create delete and user accounts in Atlassian Jira. Additionally, you can manage the groupmemberships.

Connecting to Atlassian API is straightforward. Simply utilize the API Username and API Password pair and connect using basic authentication. For further details, refer to the following pages in the Atlassian Docs: Basic auth for REST APIs.

Provisioning PowerShell V2 connector

Correlation configuration

The correlation configuration is used to specify which properties will be used to match an existing account within Atlassian Jira to a person in HelloID.

To properly setup the correlation:

1. Open the Correlation tab.

2. Specify the following configuration:

   Setting	Value
   Enable correlation	True
   Person correlation field	``
   Account correlation field	name

Tip

For more information on correlation, please refer to our correlation documentation pages.

Field mapping

The field mapping can be imported by using the fieldMapping.json file.

Connection settings

The following settings are required to connect to the API.

Setting	Description	Mandatory
Jira API URL	The URL to the Jira environment	Yes
Jira API Username	The Username to connect to the Jira environment	Yes
Jira API Token	The API token to connect to the Jira environment	Yes
IsDebug	When toggled, extra logging is shown. Note that this is only meant for debugging, please switch this off when in production.	No

Setup the connector

API token

Before you can connect to the Atlassian API and send requests, you need to register a new API token. This token serves as your gateway to the API, enabling you to establish connections and manage permissions effectively. To generate your API token, please refer to the instructions provided by Atlassian: Manage API tokens for your Atlassian account

Permissions

The Jira REST API operates under the same access restrictions as the standard Jira web interface. This means that accessing Jira via the API requires proper authentication and authorization. If you attempt to access resources without proper permissions, you will encounter similar limitations as when accessing Jira through its web interface. In essence, your access via the Jira REST API mirrors your access privileges within the Jira environment.

Getting help

Tip

For more information on how to configure a HelloID PowerShell connector, please refer to our documentation pages.

Tip

If you need help, feel free to ask questions on our forum.

HelloID docs

The official HelloID documentation can be found at: https://docs.helloid.com/