Skip to content

Update docs on trusted applications and add docs on how to cycle the API key #212

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

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Update docs on trusted applications and add docs on how to cycle the API key #212

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7c7b178
Fix formatting
kabilar Oct 28, 2025
5b780d3
Add docs on cycling API key
kabilar Oct 28, 2025
8a7bba3
Add a note about trusted applications
kabilar Oct 28, 2025
c1d4b8a
Simplify statement on trusted applications
kabilar Oct 28, 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
Binary file added docs/img/dandi_api_key_reset.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions docs/user-guide-sharing/uploading-data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,13 @@ There are two options for storing your DANDI access credentials:

- Note that there are no spaces around the "=".

- If your `DANDI_API_KEY` needs to be reset (for example, because it was publicly exposed), you can cycle your API key by following the instructions below:

1. Log in to DANDI Archive
2. Click on your user initials in the top-right corner
3. Click the circular arrow
![dandi_api_key_reset](../img/dandi_api_key_reset.png)

### 2. `keyring` Library

If the `DANDI_API_KEY` environment variable is not set, the CLI will look up the API key using the [keyring](https://github.com/jaraco/keyring) library, which supports numerous backends, including the system keyring, an encrypted keyfile, and a plaintext (unencrypted) keyfile.
Expand Down
6 changes: 5 additions & 1 deletion docs/user-guide-using/accessing-data/external-services.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# External Services

DANDI integrates with various external services to enhance data accessibility and analysis capabilities. This page describes the external services that can be used with DANDI data.
DANDI integrates with various external services to enhance data accessibility and analysis capabilities. This page describes the trusted applications that can be used with DANDI data.

In some trusted applications (e.g. Neurosift) you may enter your `DANDI_API_KEY` to view embargoed data. If you need to reset your `DANDI_API_KEY`, please see these [instructions](../../user-guide-sharing/uploading-data.md#1-dandi_api_key-environment-variable).

## NWB Explorer

Expand All @@ -14,6 +16,7 @@ DANDI integrates with various external services to enhance data accessibility an
4. Click the link to open the file in NWB Explorer

NWB Explorer allows you to:

- Browse the hierarchical structure of NWB files
- Visualize time series data
- View spike raster plots
Expand All @@ -32,6 +35,7 @@ NWB Explorer allows you to:
4. Click the link to open the file in Neurosift

Neurosift allows you to:

- Visualize spike trains and raster plots
- Explore LFP and other time series data
- View position tracking data
Expand Down