Skip to content

Authentication

Kevin Booth edited this page Oct 27, 2024 · 2 revisions

When is Authentication Needed?

Authentication to the data proxy required when performing any write actions on objects in repositories.

How to Authenticate

Authentication to the Source Cooperative Data Proxy is done via API keys generated through the Source Cooperative web interface. API keys consist of two parts, an Access Key ID and a Secret Access Key. These two parts of the API key can be used in S3 compatible clients and tools which accept an AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY as parameters for authentication to an S3 object store.

An additional configuration parameter (AWS_ENDPOINT_URL) is required when working with S3 compatible clients and tools in order to ensure that requests are routed correctly to the Source Cooperative Data Proxy. The value for this parameter can be configured as follows:

  • https://data.source.coop (for the Source Cooperative network of repositories)
  • http://localhost:8080 (for local development)

It's recommended to store your authentication configuration in the AWS Credentials File as a profile and configure your client or tool to use that profile, when possible.

Tested Clients and Tools

The data proxy has been tested to work with the following S3 compatible clients and tools:

Clone this wiki locally