added info API Ref docs

This commit is contained in:
Tana M Berry
2024-09-13 12:17:54 -05:00
parent 48ea4a9fa3
commit d85180dabd
878 changed files with 474334 additions and 2 deletions

View File

@ -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/) in our regular documentation.
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 <kbd>https://authentik.<em>company</em>/api/v3/</kbd>.
To generate an API client, you can use the OpenAPI v3 schema at <kbd>https://authentik.<em>company</em>/api/v3/schema/</kbd>.
While testing, the API requests are authenticated by your browser session.