If you’re new to Unstructured, read this note first.Before you can create a source connector, you must first sign in to your Unstructured account:
- If you do not already have an Unstructured account, sign up for free. After you sign up, you are automatically signed in to your new Unstructured Starter account, at https://platform.unstructured.io. To sign up for a Team or Enterprise account instead, contact Unstructured Sales, or learn more.
- If you already have an Unstructured Starter or Team account and are not already signed in, sign in to your account at https://platform.unstructured.io. For an Enterprise account, see your Unstructured account administrator for instructions, or email Unstructured Support at support@unstructured.io.
-
After you sign in to your Unstructured Starter account, click API Keys on the sidebar.
For a Team or Enterprise account, before you click API Keys, make sure you have selected the organizational workspace you want to create an API key for. Each API key works with one and only one organizational workspace. Learn more. -
Click Generate API Key.
-
Follow the on-screen instructions to finish generating the key.
-
Click the Copy icon next to your new key to add the key to your system’s clipboard. If you lose this key, simply return and click the Copy icon again.
- A Jira Cloud account or Jira Data Center installation.
-
The site URL for your Jira Data Center installation or Jira Cloud account.
For Jira Cloud, open Jira in your web browser and copy the address from the browser’s address bar.
If you’re unsure, check the dashboard URL, or if viewing an issue, project or board, the site URL is typically everything that comes before but not including
/jira
, such ashttps://<organization>.atlassian.net
. -
To process Jira projects, provide the IDs for the target projects. To get a project’s ID, sign in to your Jira Cloud account or Jira Data Center installation, and then go to the following URL:
https://<organization>.atlassian.net/rest/api/latest/project/<project-key>
, replacing<organization>
with yours, and replacing<project-key>
with the target project’s key. In the response, look for the URLhttps://<organization>.atlassian.net/rest/api/3/project/<project-id>
, where<project-id>
is the target project’s ID. -
To process Jira boards, the IDs for the target boards. To get a board’s ID, sign in to your Jira Cloud account or Jira Data Center installation, and then go to the following URL:
https://<organization>.atlassian.net/rest/agile/1.0/board?projectKeyOrId=<project-key-or-id>
, replacing<organization>
with yours, and<project-key-or-id>
with the associated project’s key or ID. In the response, look for the URLhttps://<organization>.atlassian.net/rest/agile/1.0/board/<board-id>
, where<board-id>
is the board’s ID. - To process Jira issues, the IDs for the target issues. To get an issue’s ID, sign in to your Jia Cloud account or Jira Data Center installation, open the issue, and then look at the URL in your browser’s address bar. The issue ID is the string of characters after the final slash in the URL.
- A user in your Jira Cloud account or Jira Data Center installation.
- The user must have the correct permissions in your Jira Cloud account or Jira Data Center installation to access the target projects, boards, and issues.
-
One of the following:
- For Jira Cloud or Jira Data Center, the target user’s name or email address, and password. Change a Jira Cloud user’s password. Change a Jira Data Center user’s password.
- For Jira Cloud only, the target user’s name or email address, and API token. Create an API token.
- For Jira Data Center only, the target user’s personal access token (PAT). Create a PAT.
<name>
(required): A unique name for this connector.<url>
(required): The URL of the Jira instance.<username>
(required for password or API token authentication): The username of the Jira user.<password>
(required for password or API token authentication): For password authentication, the password of the Jira user. For API token authentication, the API token of the Jira user.<token>
(required for personal access token authentication): The personal access token of the Jira user.<project-id>
: The ID of a target project in Jira to access.<board-id>
: The ID of a target board in Jira to access.<issue-id>
: The ID of a target issue in Jira to access.<status>
: The name of a status to filter Jira issues by.- Set
download_attachments
totrue
to download attachments from Jira issues. The default isfalse
. - Set
cloud
totrue
to specify using Jira Cloud orfalse
to specify using Jira Data Center. The default is to use Jira Data Center.