ab4a125613
* Update api.md Signed-off-by: Tana M Berry <tanamarieberry@yahoo.com> * fix Signed-off-by: Jens Langhammer <jens@goauthentik.io> --------- Signed-off-by: Tana M Berry <tanamarieberry@yahoo.com> Signed-off-by: Jens Langhammer <jens@goauthentik.io> Co-authored-by: Jens Langhammer <jens@goauthentik.io>
1.2 KiB
title
| title |
|---|
| API |
Our API reference documentation is generated, and is included here in our regular documentation Table of Contents, under API -> Reference.
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.
Authentication
For any of the token-based methods, set the Authorization header to Bearer <token>.
Session
When authenticating with a flow, you'll get an authenticated Session cookie, that can be used for authentication. Keep in mind that in this context, a CSRF header is also required.
API Token
Users can create tokens to authenticate as any user with a static key, which can optionally be expiring and auto-rotate.
JWT Token
OAuth2 clients can request the scope goauthentik.io/api, which allows their OAuth Access token to be used to authenticate to the API.