mirror of
https://github.com/goauthentik/authentik
synced 2026-04-27 09:57:31 +02:00
5997667501
* website: fix broken schema links * website: Add schema redirects. --------- Co-authored-by: Dominic R <dominic@sdko.org>
17 lines
783 B
Markdown
17 lines
783 B
Markdown
---
|
|
title: API Overview
|
|
sidebar_label: Overview
|
|
---
|
|
|
|
Our API reference documentation is generated from the [OpenAPI v3 schema](https://api.goauthentik.io/schema.yml).
|
|
|
|
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 <code>https://<em>authentik.company</em>/api/v3/</code>.
|
|
|
|
To generate an API client you can use the OpenAPI v3 schema at <code>https://<em>authentik.company</em>/api/v3/schema/</code>.
|
|
|
|
## Making schema changes
|
|
|
|
Some backend changes might require new/different fields or remove other fields. To create a new schema after changing a Serializer, run `make gen-build`.
|
|
|
|
This will update the `schema.yml` file in the root of the repository.
|