Authentication types in Custom Reports datasources

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.png

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.png

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

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

 

 

Confluence®, Jira®, Atlassian Bamboo®, Bitbucket®, Fisheye®, and Atlassian Crucible® are registered trademarks of Atlassian®
Copyright © 2005 - 2024 Appfire | All rights reserved. Appfire™, the 'Apps for makers™' slogan and Bob Swift Atlassian Apps™ are all trademarks of Appfire Technologies, LLC.