singer_sdk.authenticators.APIAuthenticatorBase

class singer_sdk.authenticators.APIAuthenticatorBase[source]

Base class for offloading API auth.

auth_headers[source]

HTTP headers for authentication.

auth_params[source]

URL query parameters for authentication.

__call__(r)[source]

Authenticate a request.

Calls authenticate_request() and returns the result.

Parameters:

r (PreparedRequest) – A requests.PreparedRequest object.

Returns:

The authenticated request object.

Return type:

PreparedRequest

__init__(stream)[source]

Init authenticator.

Parameters:

stream (_HTTPStream) – A stream for a RESTful endpoint.

Return type:

None

authenticate_request(request)[source]

Authenticate a request.

Parameters:

request (PreparedRequest) – A requests.PreparedRequest object.

Returns:

The authenticated request object.

Return type:

PreparedRequest

property config: Mapping[str, Any][source]

Get stream or tap config.

Returns:

A frozen (read-only) config dictionary map.