singer_sdk.authenticators.APIAuthenticatorBase#
- class singer_sdk.authenticators.APIAuthenticatorBase#
Base class for offloading API auth.
- __call__(r: PreparedRequest) PreparedRequest #
Authenticate a request.
Calls
authenticate_request()
and returns the result.- Parameters:
r – A request object.
- Returns:
The authenticated request object.
- __init__(stream: RESTStream) 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: PreparedRequest) PreparedRequest #
Authenticate a request.
- Parameters:
request – A request object.
- Returns:
The authenticated request object.
- property config: Mapping[str, Any]#
Get stream or tap config.
- Returns:
A frozen (read-only) config dictionary map.