From ab4a125613d2c215fedf66e99815c74faccd2d04 Mon Sep 17 00:00:00 2001 From: Tana M Berry Date: Mon, 23 Sep 2024 09:50:44 -0500 Subject: [PATCH] website/docs: clarify API browser access (#11373) * Update api.md Signed-off-by: Tana M Berry * fix Signed-off-by: Jens Langhammer --------- Signed-off-by: Tana M Berry Signed-off-by: Jens Langhammer Co-authored-by: Jens Langhammer --- website/developer-docs/api/api.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/website/developer-docs/api/api.md b/website/developer-docs/api/api.md index 7e3877be79..ca6c207210 100644 --- a/website/developer-docs/api/api.md +++ b/website/developer-docs/api/api.md @@ -2,9 +2,11 @@ title: API --- -Starting with 2021.3.5, every authentik instance has a built-in API browser, which can be accessed at https://authentik.company/api/v3/. +Our API reference documentation is generated, and is included [here](../api/reference/authentik.info.mdx) in our regular documentation Table of Contents, under **API -> Reference**. -To generate an API client, you can use the OpenAPI v3 schema at https://authentik.company/api/v3/schema/. +You can also access your installation's own, instance-specific API Browser. Starting with 2021.3.5, every authentik instance has a built-in API browser, which can be accessed at https://authentik.company/api/v3/. + +To generate an API client you can use the OpenAPI v3 schema at https://authentik.company/api/v3/schema/. While testing, the API requests are authenticated by your browser session.