Skip to end of banner
Go to start of banner

Authentication types in Custom Reports datasources

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

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

This is our default method and is common for transmitting a username and password pair. Within 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

query_parameters.png

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

  • No labels