singer_sdk.authenticators.APIAuthenticatorBase

class singer_sdk.authenticators.APIAuthenticatorBase[source]

Base class for offloading API auth.

__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 (RESTStream) – 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 auth_headers: dict[source]

Get headers.

Returns:

HTTP headers for authentication.

property auth_params: dict[source]

Get query parameters.

Returns:

URL query parameters for authentication.

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

Get stream or tap config.

Returns:

A frozen (read-only) config dictionary map.