root: move API client generation to docker-compose (#17434)

Signed-off-by: Marc 'risson' Schmitt <marc.schmitt@risson.space>
This commit is contained in:
Marc 'risson' Schmitt
2025-10-14 17:55:44 +02:00
committed by GitHub
parent 296b348bd2
commit d91dcf4eef
8 changed files with 39 additions and 38 deletions

View File

@@ -0,0 +1,38 @@
## @goauthentik/api
This package provides a generated API Client for [authentik](https://goauthentik.io?utm_source=npm-api-package).
### Building
See https://docs.goauthentik.io/docs/developer-docs/api/making-schema-changes#building-the-web-client
### Consuming
```
npm install @goauthentik/api --save
```
Create a configuration:
```typescript
import { Configuration } from "@goauthentik/api";
export const DEFAULT_CONFIG = new Configuration({
// Configure where the API is located
// Can be a full host, ensure CORS is configured
basePath: "",
// Required for POST/PUT/DELETE requests
// getCookie function must return the cookie's contents
headers: {
"X-authentik-CSRF": getCookie("authentik_csrf"),
},
});
```
Then use the API:
```typescript
import { CoreApi } from "@goauthentik/api";
const user = await new CoreApi(DEFAULT_CONFIG).coreUsersMeRetrieve();
```