Skip to content

Moving documentation from sds-data-manager README into readthedocs #3121

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 1 commit into from
May 1, 2026
Merged

Moving documentation from sds-data-manager README into readthedocs #3121

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
40 changes: 40 additions & 0 deletions docs/source/data-access/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,46 @@ Data Access URL

To change the default URL that the package accesses, you can set 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``).

API Key Management
------------------

Management of API keys is done through a script located in the
``sds_data_manager/lambda_code/authorization`` directory of the
`sds-data-manager <https://github.com/IMAP-Science-Operations-Center/sds-data-manager>`_
repository. That script can add, remove, and list current keys. To add a key,
provide the name and email of the associated user or account and receive an API
key to give to the external user for access.

Scope Options
^^^^^^^^^^^^^

When creating or updating API keys, you can specify different scopes to control
access:

- ``full``: Full read and write access to all endpoints and data
- ``read``: Read-only access. Can query and download data but cannot upload or
modify files

Usage Examples
^^^^^^^^^^^^^^

.. code-block:: bash

python sds_data_manager/lambda_code/authorization/manage_api_keys.py list
python sds_data_manager/lambda_code/authorization/manage_api_keys.py add <owner> <email> <scope>
python sds_data_manager/lambda_code/authorization/manage_api_keys.py remove <key>
python sds_data_manager/lambda_code/authorization/manage_api_keys.py update_permission <owner> <email> <scope>

# Example: add a user with full access
AWS_PROFILE=imap-sdc-dev AWS_DEFAULT_REGION=us-west-2 \
python sds_data_manager/lambda_code/authorization/manage_api_keys.py \
add "First Last" "user@example.com" "full"

# Example: add a user with read-only access
AWS_PROFILE=imap-sdc-dev AWS_DEFAULT_REGION=us-west-2 \
python sds_data_manager/lambda_code/authorization/manage_api_keys.py \
add "Read User" "reader@example.com" "read"

File Validation
---------------

Expand Down
Loading