Authorise access to the Jira API

You can skip this If you've installed Screenful via the Atlassian Marketplace.

Screenshot 2019-08-06 at 14.26.14.png

When creating a new dashboard, you'll be asked to provide URL to your Jira instance and the login credentials. 

Authorising with Jira Cloud

To authorise access to the Jira API, you need to provide the base URL of your Jira instance. If you're a Jira Cloud user, the base URL is the part that ends with atlassian.net e.g. https://mycompany.atlassian.net. 

Screen Shot 2018-07-06 at 13.24.12.png

When using Jira Cloud, you have to authenticate with Jira API is by using the API token. Go to your Atlassian account page and follow these steps to create an API token. 

On the dashboard creation wizard, enter the URL to your Jira instance and your Atlassian account email address. Instead of password, enter the API token to the field shown below:

Screenshot 2019-08-06 at 14.29.21.png

You can always prevent access using a previously generated token by deleting it, or by generating a new one.

For maximum security, you can create a dedicated user with limited access.

Authorising with Jira Server

If you're using Jira Server, the base URL depends on your domain configuration so you may need to consult your Jira admin in case you're unsure (although it's ok to use a trial and error too. If you enter incorrect URL you'll just get an error message). 

If your instance uses a non-default HTTPS port, include the port. For example jira.mycompany.com:1234. Also, If you use private DNS for your instance, use the IP address of the server instead of the hostname.

To easiest way to authorise access to the Jira API is by using the credentials of an existing user. On the dashboard creation wizard, enter your Atlassian account email address and password, and the URL to your Jira instance.

Screenshot 2019-08-06 at 14.36.40.png

For maximum security, you can create a dedicated user with limited access.