Skip to content

Clarifying readme for auth keys #288

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maxinelasp merged 2 commits into from
Dec 4, 2025
Merged

Clarifying readme for auth keys #288

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2587cd7
Clarifying readme
maxinelasp Dec 4, 2025
6212429
Move to one line
maxinelasp Dec 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 14 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,28 +132,33 @@ the environment variable ``IMAP_DATA_ACCESS_URL`` or within the
package ``imap_data_access.config["DATA_ACCESS_URL"]``. The default
is the production server ``https://api.imap-mission.com``.

### Automated use with API Keys
### Use with API Keys

The default for the CLI is to use the public endpoints.
To access some unreleased data products and quicklooks, you may
need elevated permissions. To programmatically get that, you need
need elevated permissions. To get that, you need
an API Key, which can be requested from the SDC team.

To use the API Key you can set the `IMAP_API_KEY` environment variable and then use
the tool as usual.
There are two ways to provide your API Key:

1. **Environment variable**: Set the `IMAP_API_KEY` environment variable

```bash
$ IMAP_API_KEY=<your-api-key>
$ imap-data-access ...
IMAP_API_KEY=<your-api-key> imap-data-access ...
```

or with CLI flags
2. **Command line flag**: Use the `--api-key` flag

```bash
$ imap-data-access --api-key <your-api-key> ...
imap-data-access --api-key <your-api-key> ...
```

### Automated use with Access token
The command line flag will override the environment variable if both are set.

> [!NOTE]
> When using an API key, requests are automatically routed to `api.imap-mission.com/api-key` endpoints for authentication.

### Automated use with Access token (for software)

An alternative to using an API key to access protected data is using an access token provided by LASP's authentication server. LASP's authentication uses [keycloak authentication](https://www.keycloak.org/documentation).

Expand Down