Projectmanager
Project Management Tool
Introduction
Metaport can automatically create tickets on behalf of its registered applications, by integrating with your Project Management Tool. Out of the box, Metaport supports Jira, with additional backends planned for other popular PM tools.
Setup
All Metaport Project Manager tool integrations use OAuth2 for secure authentication workflows. The following instructions assume that your Metaport account has the Owner
role, that your Jira instance has a Board, and that you have permission to access and change various aspects of Jira's configuration to allow it to communicate with Metaport. (or you can request these changes be made, on your behalf).
- Create a new "bot account" in Jira at https://admin.atlassian.com, or optionally, set this account up in your IDP (KeyCloak, Okta, Google Workspace, etc), if using SSO, and connect it to Jira.
- Locate the Jira UI for inviting users, and add the desired bot account's email address ala
metaport-bot@my-company.xyz
, then trigger an invite to it for the "Jira" product. - In the verification email sent to the bot-user's email address, click the "Go to Jira" link and fill-in the requested details when prompted.
- Select the appropriate board(s) for use with this bot user, and fill-in the fields in Metaport as follows:
Host field: This is always: https://api.atlassian.com/ex/jira
.
Account ID field: Copy/paste the accountId of the bot user into Metaport's Jira config screen:
* Go to your jira board which your bot user should already have been invited to
* Select "Teams" > "People you work with"
* Then select the the bot user under that heading
* The account ID is the URL segment after /people/
e.g. /people/712020:e5452a45-bb00-40ae-9a02-e4eac260ffeb
Project Identifier field: This is the "Cloud ID" for your Jira cloud instance. The simplest - if obscure - way to get this, is to navigate to the following url in a browser: https://dcentrica-dev.atlassian.net/_edge/tenant_info
* At the url https://developer.atlassian.com/console/myapps/
, select, or create a Metaport Jira "app"
* Set the following scopes for the "Jira API": read:jira-avatar
, read:jira-group
, read:jira-work
, read:jira-user
, write:jira-work
, offline_access
(see: https://developer.atlassian.com/console/myapps/
).
* Ensure the Jira "app" is set to be "Distributed".
* Ensure the global "Browse users and groups" permission has been set. This can be set here (at the bottom of the screen): https://<your_jira_site>.atlassian.net/secure/admin/GlobalPermissions!default.jspa
.
Client ID field: Go to https://developer.atlassian.com/console/myapps/ and securely copy/paste the clientId.
Client Secret field: Go to https://developer.atlassian.com/console/myapps/ and securely copy/paste the clientSecret.
Note
The ClientSecret
is encrypted prior to being stored in Metaport's database.