Add documentation for API key management

riehlegroup · Dec 14, 2022 · e8c280e · e8c280e
1 parent 5c5a532
commit e8c280e
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 3 deletions.
diff --git a/docs/api-keys-creation-swagger-screenshot.png b/docs/api-keys-creation-swagger-screenshot.png
diff --git a/docs/api-keys-creation-ui-screenshot.png b/docs/api-keys-creation-ui-screenshot.png
diff --git a/docs/api-keys-ui-screenshot.png b/docs/api-keys-ui-screenshot.png
diff --git a/docs/api-keys.md b/docs/api-keys.md
@@ -1,7 +1,21 @@
 # API Keys
 
-- Use API doc on rout `/api` to generate API keys.
+**API keys** are used as an alternative authentication method to speak with parts of the server API.
+We recommend using them in your **CI pipelines**.
 
-## Planned
+## Managing API Keys
 
-- Manage API keys via UI
+### via Frontend
+
+- Find the API key management page in the left main menu.
+  ![UI API Keys Management](./api-keys-ui-screenshot.png)
+- Use the `CREATE API KEY` button to start the API-key creation process. Assign it a speaking name in case you need to invalidate it in the future. Keys are valid until invalidated manually.
+- Copy the created key. After closing the dialogue, there is no way to get your hands on the key again unless you generate a new one.
+  ![UI API Key Created](./api-keys-creation-ui-screenshot.png)
+- Use the key in your CI pipeline (e.g., by using a CI secret).
+
+### via the API
+
+- Use the API directly to generate API keys.
+- You can use Swagger UI to do so on `{url}:{port}/api`, e.g., on `http://localhost:3000/api`
+  ![Swagger API Key Created](./api-keys-creation-swagger-screenshot.png)