Skip to main content
Sign in

Creating an extended integration for Jira Cloud users

Caroline Maguire
  • May 11, 2022 14:40
  • Updated

Let Oomnitza be your single source of truth!

You'll get visibility of your Jira users as data from Jira is automatically transformed into consumable information and actionable insights.

Oomnitza offers multiple integrations with Atlassian Jira Cloud. Jira in this case refers to Jira Cloud, as these APIs might not be available within Jira Data Center or Jira Server versions. You can pull the users from Jira into Oomnitza to then manage these users within the People or SaaS module and you can integrate with Jira as your organization's ticketing system.

Connect Oomnitza and Jira in minutes

Get the information and insights that you need to reduce costs and the time that you spend on administration tasks such as:

  • Configurable dashboards and list views of key user information
  • Configurable reports to share information about users with your colleagues and management
  • Configurable workflows that you can easily create such as:
    • Workflows for creating and deleting users
    • Workflows for updating the status of an issue and adding comments
    • Workflows for managing Jira users within the SaaS module and much more. 

Navigation

small_blue_link.svgAdding your credentials

Adding your basic credentials

Adding your OAuth credentials

small_blue_link.svgAdding Jira global variables

Adding JIRA global variables for basic authentication

Adding JIRA global variables for OAuth

small_blue_link.svgCreating the user integration

small_blue_link.svgCreating custom mappings

small_blue_link.svg Creating workflows

Creating user workflows with the API block

Add Comment to Issue preset

Change Issue Status with Comment preset

Create Issue preset

Create User preset

Delete User preset

Get User preset (OAuth)

Delete User preset (OAuth)

Creating Saas user workflows

User Role preset

Before you start

Best practice
For the integration with Oomnitza, create a dedicated user account.

For this integration you can use Jira basic authentication for the following presets:

Add Comment to Issue preset

Change Issue Status with Comment preset

Create Issue preset

Create User preset

Delete User preset

User Role preset

You can use OAuth for the following:

Creating the user integration

Get User preset (OAuth)

Delete User preset (OAuth)

Jira basic authentication

For Jira basic authentication, you will need your Jira username and API token. You can obtain your API token by completing the following steps:

  1. Log in to https://id.atlassian.com/manage/api-tokens.
  2. Click Create API token.
  3. From the dialog that appears, enter a memorable label for your token and click Create.

Result: Your API token is generated. Make sure you copy your new API token as it will not be visible again. 

For further information, refer to Jira API documentation: Creating an API token.

Next step

Add the credentials that you created to the Oomnitza vault, by following the steps in Adding your basic credentials.

Jira OAuth

For Jira OAuth, you will need to have a Client ID and Secret. You must be a site admin for Jira Cloud, as well as an admin for the tool you wish to integrate with. To create your OAuth credentials:

  1. In Jira, select the cog icon on the top right of the page, and then select Apps.
  2. From the sidebar, select OAuth credentials.
  3. Select Create credentials.
  4. Enter your OAuth details and click Create.

Result: Your Client ID and Secret is generated. Copy these details for use when Adding your OAuth credentials. 

For further information, refer to Jira API documentation: Creating OAuth credentials in Jira Cloud.

Next step

Add the credentials that you created to the Oomnitza vault, by following the steps in Adding your OAuth credentials.

Adding your credentials

Before you can configure any of the available integrations with Jira, you need to add credentials in the vault. For this integration, you have the option to use basic authentication or OAuth. 

Adding your basic credentials

  1. In Oomnitza, click Settings > Credentials.
  2. Click Add new credential (+).
  3. Add the information details.
  4. Click the AUTHORIZATION tab.
  5. Ensure that Basic Auth is selected as the authorization type.
  6. Enter the user name of your Jira account.
  7. Enter your password. Your password is the API token you generated by following the steps in Jira basic authentication.
  8. Click Create. 

Adding your OAuth credentials

  1. In Oomnitza, click Settings > Credentials.
  2. Add the information details.
  3. Click the AUTHORIZATION tab.
  4. As authorization type select OAuth 2.0.
  5. From the SaaS list, select Jira.Jira OAuth 2.0.
  6. Enter the Client ID and Client Secret that you generated in Jira OAuth. 
  7. Enter your Jira Scopes such as read:jira-user. For further information, refer to the Jira scopes for OAuth.
  8. Authenticate the connection.
  9. Click CREATE. 

Adding Jira global variables

To save time when create workflows, create global variables in Oomnitza depending on what type of authentication you use.

Adding JIRA global variables for basic authentication

  1. From the menu, click Settings.
  2. Click Global Settings.
  3. Click Add new variable (+).
  4. Add the Jira.Subdomain variable and its value. The value is the name of your Jira subdomain. If your Jira URL is https://mycompany.atlassian.netyour subdomain would be: mycompany.
  5. Save your changes.
  6. Follow steps 1 to 3 above.
  7. Add the Jira.Issue_Type variable and its value. Typical values for this include Bug, Task, Sub-task. The value depends on the configuration of your Jira instance and should be validated there.
  8. Save your changes.

Next step

Now that basic authentication has been set up, you can create user workflows with the API block in Oomnitza. 

Adding JIRA global variables for OAuth

  1. From the menu, click Settings.
  2. Click Global Settings.
  3. Click Add new variable (+).
  4. Add the Jira.Cloud Id variable and its value. The value is the name of your Jira Cloud ID. You can obtain your Cloud ID by going to https://admin.atlassian.com/. Click your site or account. The Cloud ID is a series of letters and numbers separated by dashes. If your URL is https://admin.atlassian.com/s/0c123456-d123-1a12-1e01-123d1dc1234c/your Cloud ID would be: 0c123456-d123-1a12-1e01-123d1dc1234c
  5. Save your changes.

Next step

Now that OAuth has been set up, you can create a user integration in Oomnitza. 

Creating the user integration

You can use your OAuth credentials to create a user integration with Jira. 

Info and connect details

  1. From the menu, click Settings.
  2. Click Integrations List View small_SettingsListView.svg.
  3. On the Integrations page, scroll down to the Extended section for User Integrations.
  4. Click NEW INTEGRATION.
  5. In the New User Integration sidebar, click Jira.
  6. Click APPLY next to the Jira User Load, and then click NEXT twice.

Connect page

Best practice
To ensure that only live user records are streamed to Oomnitza, choose Update only as your integration preference. When you run the integration, you can check the error logs to see which user records weren't uploaded and why they weren't uploaded. You can then decide whether to upload the user records that were skipped by changing your integration preference to create and upload. See Access error logs.

On the connect page, complete the following steps to connect the integration:

  1. Enter a descriptive name for the integration such as Jira User Load. This name will be displayed on the Integrations page once the setup is complete.
  2. From the User Selection list, select User plus SaaS User.
  3. From the Installation type list, select Cloud.
  4. From the Credentials list, select your OAuth credentials that you created in Adding your OAuth credentials.
  5. From the Integration Preferences list, select Update only.   
  6. Enter the name of the user of the integration.
  7. Enter your Jira Cloud ID. 
  8. Click Next.

Creating custom mappings

Map the Jira fields to Oomnitza fields and create custom mappings to get the user information that you need.

Complete these actions:

    1. Click Smart Mapping.
    2. Create a custom mappings to map the Account Id to Oomnitza. To create the mapping, do the following:
      1. Click the down arrow on the Account Id field.
      2. Select Add new Oomnitza users field.
      3. Change the name of the field to Jira User Id.
      4. Click CREATE. 
  2. You have the option to create custom mappings to map any other field that you want to add to Oomnitza. To create an optional custom mapping, do the following:
    1. Click the down arrow on the field that you want to map.
    2. Select Add new Oomnitza users field.
    3. Change the name of the field.
    4. Click CREATE. 
  3. Assign a sync key to the Email field.
  4. Click NEXT.

Note: For all user loads, it is recommended that you map role information to an employee role in Oomnitza. Users need to have an employee role defined in order to access Oomnitza. If the role information is not available from the user load, it is recommended that you select Employee from the Oomnitza Role dropdown list. You have the option to overwrite this at a later point should the role information become available. 

Standard Jira to Oomnitza mappings

The following Jira fields can be mapped to Oomnitza:

Account Id
Email Address
Account Type
Application Roles Items List
Application Roles Size
Avatar 16x16 URL
Avatar 24x24 URL
Avatar 32x32 URL
Avatar 48x48 URL
Connector Sync Time
Display Name
Expand
Groups Items List
Groups Size
Is Active
Locale
Time Zone
User URL Self

Want to map more fields to Oomnitza?
Contact Support, or see Mapping extended connectors.

When you've completed mapping the Jira to Oomnitza fields, click NEXT.

Schedule

By default, user data is streamed to Oomnitza once every day.

You can configure the schedule to meet your needs such as changing the interval or changing the time so that the data is streamed when your system isn't busy.

  1. Configure your schedule.
  2. Click FINISH.

Result

A new tile is created for the integration on the Integrations page. 

What to do next

If you want to see the information that is collected now, click the tile on the Integrations page and click RUN NOW.

If you want to change the integration settings, you can click a navigation link on the page, such as 4 Mappings, and edit the settings. 

edit-integration.svg

Tip
To view the information that is collected about your mobile assets, click Assets. 

Creating workflows

Creating user workflows with the API block

To reduce your workload and automate complex and repetitive tasks, you can create user workflows with the API block by following the steps in Creating workflows with the API block. The Jira API block workflow comes with the following presets for assets:

Add Comment to Issue preset

Change Issue Status with Comment preset

Create Issue preset

Create User preset

Delete User preset

Get User preset (OAuth)

Delete User preset (OAuth)

To locate the available presets, enter Jira in the Select Preset search field.

Using the Jira Add Comment to Issue preset

The Jira Add Comment to Issue preset allows you to add a comment to a Jira issue. In order to enable this, you need to select this preset from the list of available API block integrations and then provide the following parameters in configuration:

Use the Advanced Mode to configure the message payload. To do this, 

  1. In the API block window, click the Advanced Mode button located in the upper right of the window.
  2. In the Information tab, you will notice that the Jira ticket number is assumed to be stored within a workflow variable jira_ticketno (data type short text). You can replace this with the actual ticket number or a different variable if you prefer. For further information on workflow variables refer to Creating a Workflow variable.
  3. Select the Body tab. Modify, update or add fields that will be used in the request payload. For information on the fields that are permitted in the request payload, refer to the Jira API documentation: Add comment.
  4. Select the Response tab. You have the option to map the Response field {{response}} to a custom long text Oomnitza field. You can create a custom field by going to People>Customization. For further information, see Creating Custom Fields in Oomnitza.

Using the Jira Change Issue Status with Comment preset

The Jira Change Issue Status with Comment preset allows you to add a comment to a Jira issue and perform an issue transition (for example, transitioning an issue from To do to Closed). In order to enable this, you need to select this preset from the list of available API block integrations and provide the following parameters in configuration:

  • Your basic credentials that you added in Adding your basic credentials.
  • Your Jira subdomain is derived from the global variable you created in Adding JIRA global variables for basic authentication, or can be manually added.
  • Comment - the comment you want to add to your Jira ticket. 
  • Transition ID - the transition ID of the transition object you want to move the Jira ticket to. For example, if you wish to move your ticket from In Progress to Done you will need to find the transition ID of Done. You can find the transition ID within your Jira instance by going to Settings>Issues >Workflows>Text. You will see the transition ID in brackets next to the transition name, for example Done(5).

Use the Advanced Mode to configure the message payload as described in Using the Jira Add Comment to Issue preset. For additional information, refer to the Jira API documentation: Transition issue.

Using the Jira Create Issue preset

The Jira Create Issue preset allows you to create an issue within your Jira instance. In order to enable this, you need to select this Preset from the list of available API block integrations and then provide the following parameters in configuration:

  • Your basic credentials that you added in Adding your basic credentials.
  • Your Jira subdomain and issue type is derived from the global variable you created in Adding JIRA global variables for basic authentication, or can be manually added.
  • Project Key - The Project Key is the prefix of the issue number. In the example of JRA-123, the JRA portion of the issue number is the Project Key. 
  • Issue Summary - A summary of the issue.
  • Issue Description - A description of the issue. 

Use the Advanced Mode to configure the message payload. To do this, 

  1. In the API block window, click the Advanced Mode button located in the upper right of the window.
  2. Select the Body tab. Modify, update or add fields that will be used in the request payload. For information on the fields that are permitted in the request payload, refer to the Jira API documentation: Create issue.
  3. Select the Response tab. You have the option to map the Response field {{response}} to a custom long text Oomnitza field. You can create a custom field by going to People>Customization. For further information, see Creating Custom Fields in Oomnitza.

Using the Jira Create User preset

The Jira Create User preset allows you to create a user within your Jira instance by sending the username, display name and email address in the payload. In order to enable this, you need to select this preset from the list of available API block integrations and then provide the following parameters in configuration:

Use the Advanced Mode to configure the message payload. To do this, 

  1. In the API block window, click the Advanced Mode button located in the upper right of the window.
  2. Select the Body tab. Modify, update or add fields that will be used in the request payload. For information on the fields that are permitted in the request payload, refer to the Jira API documentation: Create user.
  3. Select the Response tab. You have the option to map the Response field {{response}} to a custom long text Oomnitza field. You can create a custom field by going to People>Customization. For further information, see Creating Custom Fields in Oomnitza.

Using the Jira Delete User preset

The Jira Delete User preset allows you to delete/deactivate a user from Jira. In order to enable this, you need to select this preset from the list of available API block integrations and then provide the following parameters in configuration:

Use the Advanced Mode to configure the message payload. To do this, 

  1. In the API block window, click the Advanced Mode button located in the upper right of the window.
  2. Select the Information tab. The Jira user id is assumed to be stored in the {{user_external_id}} field. You can replace this with the actual user id or a different variable if you prefer.
  3. Select the Response tab. You have the option to map the entire response by adding {{response}} in the Response field to an Oomnitza field. For example, you could map {{response}} to a Jira API response long text field created by following the steps in Creating Custom Fields in Oomnitza.

For further information refer to the Jira API documentation: Delete user.

Using the Jira Get User preset (OAuth)

The Jira Get User preset allows you to get a user from your Jira instance. In order to enable this, you need to select this preset from the list of available API block integrations and then provide the following parameters in configuration:

Use the Advanced Mode to configure the message payload. To do this, 

  1. In the API block window, click the Advanced Mode button located in the upper right of the window.
  2. In the Information tab, you will notice that the Jira user id is referenced in the variable {{jira_user_id}} that you created in Creating custom mappings. If you have not done this, you can replace the value {{jira_user_id}} in the URL with the correct field or user id. 
  3. Select the Response tab. You have the option to map the entire response by adding {{response}} in the Response field to an Oomnitza field. For example, you could map {{response}} to a Jira API response long text field created by following the steps in Creating Custom Fields in Oomnitza.

For further information refer to the Jira API documentation: Get user.

Using the Jira Delete User preset (OAuth)

The Jira Delete User preset allows you to delete a user from Jira. In order to enable this, you need to select this preset from the list of available API block integrations and then provide the following parameters in configuration:

Use the Advanced Mode to configure the message payload. To do this, 

  1. In the API block window, click the Advanced Mode button located in the upper right of the window.
  2. Select the Information tab. The Jira user id is assumed to be stored in the {{user_external_id}} field. You can replace this with the actual user id or a different variable if you prefer.
  3. Select the Response tab. You have the option to map the entire response by adding {{response}} in the Response field to an Oomnitza field. For example, you could map {{response}} to a Jira API response long text field created by following the steps in Creating Custom Fields in Oomnitza.

For further information refer to the Jira API documentation: Delete user.

Creating Saas user workflows

You can create the SaaS User workflow by following the steps in Creating Saas user workflows. When creating the SaaS User workflow for Jira, the following specific configuration is required:

  • To locate the available presets, enter Jira in the Select Preset search field.

The Jira SaaS User workflow block comes with one available preset, the Jira User Role preset.

Using the Jira User Role preset

The Jira User Role preset enables you to read a user’s role from Jira. When you select this preset, enter the following details in the Configure section:

For further information refer to the Jira API documentation: Get application role.

For further information on workflows see:
small_blue_link.svg Understanding workflows
small_blue_link.svg Workflow block overview

Unleash the power of Oomnitza

To get valuable actionable insights that help you manage your assets, learn how to:

      • Configure dashboards for your users and software
      • Configure custom reports about your users and software
      • Create workflows to automate tasks

See small_blue_link.svg Getting started for more information.

Related articles

Comments

0 comments

Please sign in to leave a comment.

Powered by Zendesk