Skip to content

Commit

Permalink
Update to README.md regarding API keys.
Browse files Browse the repository at this point in the history
  • Loading branch information
AlanSimmons committed Jun 11, 2024
1 parent 11af25d commit 710c5c3
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,12 @@ If you are working with a local Docker distribution based on from [ubkg-neo4j](h
- USERNAME=neo4j
- PASSWORD= the value of _neo4j_password_ from the common **container.cfg** file.

## Using API keys
Some deployments based on the UBKG API may require that calls to endpoints include an API key in the header.
Because this involves integration with authorization architecture (e.g., API gateways and authorization specific to a
network resource), the configuration of API keys is beyond the scope of the UBKG API.


### Starting your neo4j instance
If you are using a local instance of the UBKG, the instance should be running.
In particular, if you installed a local Docker instance of UBKG, be sure that Docker Desktop is running.
Expand Down

0 comments on commit 710c5c3

Please sign in to comment.