Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

Custom Reports supports multiple authentication methods to securely connect to your REST APIs. Choose the required authentication by your API and enter the necessary credentials during datasource creation.

authentication_types.pngImage Modified

On this page:

Table of Contents
minLevel1
maxLevel6
outlinefalse
styledisc
typelist
printabletrue

No Auth

This authentication type is utilized when the endpoint you are accessing does not require authentication. It lets you define the URL of your endpoints and modify it in a single location, eliminating the need to edit the report’s descriptor.

API Key

In this scenario, you will be prompted to provide a key-value pair, which will be used as either a query parameter or a header in requests to API endpoints that necessitate this authentication format.

Bearer Token

This authentication mechanism is widely recognized among developers. Your token will be included as part of the authorization header in each request.

Basic Authentication

The basic authentication requires users to send a username and password to authenticate your request. However, in the Atlassian’s ecosystem, you are required to provide your email address and an API token as the password.

basic_authentication.pngImage Modified

Query parameters

Parameters allow you to define specific query details to refine the data fetched from the API.

Examples:

  • ?status=active&dateRange=last30days

  • ?limit=50&page=2

query_parameters.pngImage Modified

Headers

Headers are used to send additional information with your API requests, such as authentication details or content types.

Examples:

  • Authorization: Bearer <token>

  • Content-Type: application/json

headers.pngImage Modified