From 710c5c37f4f542ffbe20c967e4ea93406289d2d0 Mon Sep 17 00:00:00 2001 From: AlanSimmons Date: Tue, 11 Jun 2024 11:16:48 -0400 Subject: [PATCH] Update to README.md regarding API keys. --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index d5b5f75..6b4a00b 100644 --- a/README.md +++ b/README.md @@ -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.