This repository has been archived on 2024-05-31. You can view files and clone it, but cannot push or open issues or pull requests.
authentik/scripts/api-ts-templates
Jens L fd6a3d6230
root: update options for generating TS API (#3833)
2022-10-21 09:08:25 +02:00
..
README.mustache root: update options for generating TS API (#3833) 2022-10-21 09:08:25 +02:00

README.mustache

## @goauthentik/api

This package provides a generated API Client for [authentik](https://goauthentik.io?utm_source=npm-api-package).

### Building

See https://goauthentik.io/developer-docs/making-schema-changes

### 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();
```