HttpQueryStringAuth

HttpQueryStringAuth#

class eodag.plugins.authentication.qsauth.HttpQueryStringAuth(provider, config)[source]#

An Authentication plugin using HTTP query string parameters.

This plugin sends credentials as query-string parameters.

Parameters:

  • provider (str) – provider name

  • config (PluginConfig) –

    Authentication plugin configuration:

    • type (str) (mandatory): HttpQueryStringAuth

    • auth_uri (str): used to check the credentials given in the configuration

Using HTTPDownload a download link http://example.com?foo=bar will become http://example.com?foo=bar&apikey=XXX&otherkey=YYY if associated to the following configuration:

provider:
    credentials:
        apikey: XXX
        otherkey: YYY

The plugin is configured as follows in the providers config file:

provider:
    ...
    auth:
        plugin: HttpQueryStringAuth
        auth_uri: 'http://example.com?foo=bar'
        ...
    ...

If auth_uri is specified (optional), it will be used to check credentials through authenticate()

__init__(provider, config)#
Parameters:

Methods

__init__(provider, config)

authenticate()

Authenticate

authenticate_objects(bucket_names_and_prefixes)

Authenticates with s3 and retrieves the available objects

validate_config_credentials()

Validate configured credentials

Attributes

plugins

Contents