Adding your Jira credentials to Oomnitza

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

For the integration with Jira, you can use OAuth or Basic Authentication.

Use Basic authentication for the following workflows:

• Add Comment to issue
• Change Issue Status with Comment
• Create Issue
• Create User
• Delete User

Use OAuth authentication for the following:

• Delete User workflow
• Get User workflow

Adding authentication credentials for Jira

To add your authentication credentials to Oomnitza, you must:

• Retrieve your API token
• Add your Jira credentials to Oomnitza

Retrieving your Jira API token

To use basic authentication in Oomnitza, you must retrieve a Jira API token. 

1. Log in to https://id.atlassian.com/manage/api-tokens.
2. Click Create API token.
3. Enter a label for your token and click Create.

Adding your credentials

When you add your credentials, enter the email associated with your Jira account as the username and your API token as the password.

1. In Oomnitza, click Configuration > Security > Credentials.
2. Click Add new credential (+).
3. Click Advanced Mode 
4. Add the information details.
5. Click the AUTHORIZATION tab.
6. Ensure that Basic Auth is selected as the authorization type.
7. Enter the username in the username field and the API Token in the password field of the new credential.
8. Click Create. 

Related documentation

Jira Documentation: Manage API tokens for your Atlassian account

OAuth

To use OAuth authentication in Oomnitza, you need to have the following information to hand:

• Your Jira Client ID and Secret.
• Your Jira Scopes.

Jira Client ID and Secret

To create your OAuth credentials:

1. Log in to developer.atlassian.com
2. Select your profile icon in the top-right corner and select Developer console.
3. In the My Apps page, click Create > OAuth 2.0 integration
4. Provide an app name and click Create
5. Select Authorization in the left menu.
6. Next to OAuth 2.0 (3LO), select Add.
7. Enter the following Callback URL https://generic-oauth2-proxy.oomnitza.com/oauth2/redirect_url
8. Click Save changes.
9. Select Permissions in the left menu.
10. Click Add for the Jira API and then click Configure
11. Click Edit Scopes
12. Select the View user profiles scope, code name read:jira-user
13. Select Settings in the left menu.
14. In the Authentication details section, copy your Client ID and Secret.

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

Scopes

This user load uses the Get Users API which requires theread:jira-userscope. See Jira API Documentation: Get user.

Adding your OAuth credentials to Oomnitza

1. In Oomnitza, click Configuration > Security > Credentials.
2. Click Add new credential (+).
3. Search for the integration, and then click the forward arrow > to select the integration. 
4. Enter your client credentials and any other additional information.
5. Click Authenticate. You are prompted to log in to authorize your request.
6. Click CREATE.

Information
If the integration is not listed, click Advanced Mode, and add your credentials.

1. Add the information details.
2. Click the AUTHORIZATION tab.
3. Ensure that OAuth 2.0 is selected as the Authorization type.
4. Ensure that Jira is selected from the SaaS list.
5. Enter the Client ID and Client Secret.
6. Enter your Jira Scopes such as read:jira-user. 
7. Authenticate the connection. If you are already logged in to Jira in another browser, the pop-up will automatically detect your Jira credentials so you do not need to log in. You will be asked to select your site in the Authorize for dropdown.
8. Click Accept
9. Click CREATE.