Documentation Index

Fetch the complete documentation index at: https://docs.supermetrics.com/llms.txt

Use this file to discover all available pages before exploring further.

Authentication

Prev Next

Almost all data sources require user authentication to access data. The most prevalent methods include OAuth2 and API key authentication.

The Authentication component enables you to configure how the access token is acquired from the connector user. In other words, it defines how the authentication flow to the connector works.

To ensure secure storage of access tokens, it’s advised to configure the authentication component instead of using access tokens directly in the configuration.

Note

If the data source does not require authentication, you don’t need to include an authentication component in your configuration.

Supported authentication methods

Our connectors support all the most common authentication methods:

Authetication type

Type defined in the configuration

API key (header or query param)

user_input

OAuth2

oauth2 or single_step_oauth2

OAuth1

oauth1

Basic authentication (username and password)

basic

Session-based authentication (cookies)

cookie

JSON Web Token

jwt

Amazon S3

amazon_s3

Microsoft Exchange

exchange

Below you can find documentation for the most common authentication methods and authentication configurations.

Note

Some APIs require cryptographic request signing in addition to authentication. If your data source requires signed requests (e.g., HMAC or RSA signatures), you can configure this separately using Request signers. Request signers work alongside any authentication method.