singer_sdk.authenticators.APIKeyAuthenticator

class singer_sdk.authenticators.APIKeyAuthenticator[source]

Implements API key authentication for REST Streams.

This authenticator will merge a key-value pair with either the HTTP headers or query parameters specified on the stream. Common examples of key names are “x-api-key” and “Authorization” but any key-value pair may be used for this authenticator.

__init__(stream, key, value, location='header')[source]

Create a new authenticator.

Parameters:

  • stream (_HTTPStream) – The stream instance to use with this authenticator.

  • key (str) – API key parameter name.

  • value (str) – API key value.

  • location (str) – Where the API key is to be added. Either ‘header’ or ‘params’.

Raises:

ValueError – If the location value is not ‘header’ or ‘params’.

Return type:

None

classmethod create_for_stream(stream, key, value, location)[source]

Create an Authenticator object specific to the Stream class.

Parameters:

  • stream (_HTTPStream) – The stream instance to use with this authenticator.

  • key (str) – API key parameter name.

  • value (str) – API key value.

  • location (str) – Where the API key is to be added. Either ‘header’ or ‘params’.

Returns:

A new

singer_sdk.authenticators.APIKeyAuthenticator instance.

Return type:

APIKeyAuthenticator