Interacting with the CollabTools API

There are 4 overarching requirements to enable interaction with the CollabTools API:

1. an active account for the CollabTool
2. a personal access token for the CollabTool
3. additional headers
4. application specific permissions

A reminder that PKI credentials are ALWAYS required no matter what authentication path (API or GUI) you use.

Active Account

You will need to have an active account in the CollabTool for which you want to make API calls. If you can’t log into the CollabTool, take a look at the following help articles:

https://arcus.mil/kb/accounts/

Bottom Line: If you can’t log in to the CollabTool through your browser you will never be able to make calls to the API.

Personal Access Token (PAT)

Use the following instructions to generate a PAT for the target CollabTool.

• GitLab - https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html

• Bitbucket - https://confluence.atlassian.com/bitbucketserver0721/managing-http-access-tokens-1115666701.html

• Confluence - https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html

• Jira - https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html

Additional Headers

To successfully route to the CollabTool API endpoint, you need to include the following values in your cookie that accompanies the API call:

dashboard: yes
consent: true

Application Specific Permissions

Finally, to complete the call you need to ensure your API user has appropriate permissions within the application (e.g., create an issue, add comment, upload document).