singer_sdk.authenticators.APIAuthenticatorBase

class singer_sdk.authenticators.APIAuthenticatorBase

Base class for offloading API auth.

__init__(stream: Stream) → None

Init authenticator.

Parameters

stream – A stream for a RESTful endpoint.

property auth_headers: dict

Get headers.

Returns

HTTP headers for authentication.

property auth_params: dict

Get query parameters.

Returns

URL query parameters for authentication.

authenticate_request(request: Request) → None

Authenticate a request.

Parameters

request – A request object.

property config: Mapping[str, Any]

Get stream or tap config.

Returns

A frozen (read-only) config dictionary map.