diff --git a/docs/api-keys-creation-swagger-screenshot.png b/docs/api-keys-creation-swagger-screenshot.png new file mode 100644 index 0000000..7c90fbb Binary files /dev/null and b/docs/api-keys-creation-swagger-screenshot.png differ diff --git a/docs/api-keys-creation-ui-screenshot.png b/docs/api-keys-creation-ui-screenshot.png new file mode 100644 index 0000000..bd6a25e Binary files /dev/null and b/docs/api-keys-creation-ui-screenshot.png differ diff --git a/docs/api-keys-ui-screenshot.png b/docs/api-keys-ui-screenshot.png new file mode 100644 index 0000000..8a8bc50 Binary files /dev/null and b/docs/api-keys-ui-screenshot.png differ diff --git a/docs/api-keys.md b/docs/api-keys.md index 524ba63..91ee697 100644 --- 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)