@goauthentik/api 2026.2.0-rc1-1766432129 → 2026.2.0-rc1-1767654897

package/docs/SSFStream.md

@@ -0,0 +1,51 @@
+
+# SSFStream
+
+SSFStream Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | string
+`provider` | number
+`providerObj` | [SSFProvider](SSFProvider.md)
+`deliveryMethod` | [DeliveryMethodEnum](DeliveryMethodEnum.md)
+`endpointUrl` | string
+`eventsRequested` | [Array<EventsRequestedEnum>](EventsRequestedEnum.md)
+`format` | string
+`aud` | Array<string>
+`iss` | string
+
+## Example
+
+```typescript
+import type { SSFStream } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+  "provider": null,
+  "providerObj": null,
+  "deliveryMethod": null,
+  "endpointUrl": null,
+  "eventsRequested": null,
+  "format": null,
+  "aud": null,
+  "iss": null,
+} satisfies SSFStream
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SSFStream
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/Schedule.md

@@ -0,0 +1,56 @@
+
+# Schedule
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`identifier` | string
+`uid` | string
+`actorName` | string
+`relObjAppLabel` | string
+`relObjModel` | string
+`relObjId` | string
+`crontab` | string
+`paused` | boolean
+`nextRun` | Date
+`description` | string
+`lastTaskStatus` | [LastTaskStatusEnum](LastTaskStatusEnum.md)
+
+## Example
+
+```typescript
+import type { Schedule } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "identifier": null,
+  "uid": null,
+  "actorName": null,
+  "relObjAppLabel": null,
+  "relObjModel": null,
+  "relObjId": null,
+  "crontab": null,
+  "paused": null,
+  "nextRun": null,
+  "description": null,
+  "lastTaskStatus": null,
+} satisfies Schedule
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Schedule
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ScheduleRequest.md

@@ -0,0 +1,38 @@
+
+# ScheduleRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`relObjId` | string
+`crontab` | string
+`paused` | boolean
+
+## Example
+
+```typescript
+import type { ScheduleRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "relObjId": null,
+  "crontab": null,
+  "paused": null,
+} satisfies ScheduleRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ScheduleRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SchemaApi.md

@@ -0,0 +1,85 @@
+# SchemaApi
+
+All URIs are relative to */api/v3*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**schemaRetrieve**](SchemaApi.md#schemaretrieve) | **GET** /schema/ |  |
+
+
+
+## schemaRetrieve
+
+> { [key: string]: any; } schemaRetrieve(format, lang)
+
+
+
+OpenApi3 schema for this API. Format can be selected via content negotiation.  - YAML: application/vnd.oai.openapi - JSON: application/vnd.oai.openapi+json
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SchemaApi,
+} from '@goauthentik/api';
+import type { SchemaRetrieveRequest } from '@goauthentik/api';
+
+async function example() {
+  console.log("🚀 Testing @goauthentik/api SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: authentik
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new SchemaApi(config);
+
+  const body = {
+    // 'json' | 'yaml' (optional)
+    format: format_example,
+    // 'af' | 'ar' | 'ar-dz' | 'ast' | 'az' | 'be' | 'bg' | 'bn' | 'br' | 'bs' | 'ca' | 'ckb' | 'cs' | 'cy' | 'da' | 'de' | 'dsb' | 'el' | 'en' | 'en-au' | 'en-gb' | 'eo' | 'es' | 'es-ar' | 'es-co' | 'es-mx' | 'es-ni' | 'es-ve' | 'et' | 'eu' | 'fa' | 'fi' | 'fr' | 'fy' | 'ga' | 'gd' | 'gl' | 'he' | 'hi' | 'hr' | 'hsb' | 'hu' | 'hy' | 'ia' | 'id' | 'ig' | 'io' | 'is' | 'it' | 'ja' | 'ka' | 'kab' | 'kk' | 'km' | 'kn' | 'ko' | 'ky' | 'lb' | 'lt' | 'lv' | 'mk' | 'ml' | 'mn' | 'mr' | 'ms' | 'my' | 'nb' | 'ne' | 'nl' | 'nn' | 'os' | 'pa' | 'pl' | 'pt' | 'pt-br' | 'ro' | 'ru' | 'sk' | 'sl' | 'sq' | 'sr' | 'sr-latn' | 'sv' | 'sw' | 'ta' | 'te' | 'tg' | 'th' | 'tk' | 'tr' | 'tt' | 'udm' | 'ug' | 'uk' | 'ur' | 'uz' | 'vi' | 'zh-hans' | 'zh-hant' (optional)
+    lang: lang_example,
+  } satisfies SchemaRetrieveRequest;
+
+  try {
+    const data = await api.schemaRetrieve(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **format** | `json`, `yaml` |  | [Optional] [Defaults to `undefined`] [Enum: json, yaml] |
+| **lang** | `af`, `ar`, `ar-dz`, `ast`, `az`, `be`, `bg`, `bn`, `br`, `bs`, `ca`, `ckb`, `cs`, `cy`, `da`, `de`, `dsb`, `el`, `en`, `en-au`, `en-gb`, `eo`, `es`, `es-ar`, `es-co`, `es-mx`, `es-ni`, `es-ve`, `et`, `eu`, `fa`, `fi`, `fr`, `fy`, `ga`, `gd`, `gl`, `he`, `hi`, `hr`, `hsb`, `hu`, `hy`, `ia`, `id`, `ig`, `io`, `is`, `it`, `ja`, `ka`, `kab`, `kk`, `km`, `kn`, `ko`, `ky`, `lb`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `my`, `nb`, `ne`, `nl`, `nn`, `os`, `pa`, `pl`, `pt`, `pt-br`, `ro`, `ru`, `sk`, `sl`, `sq`, `sr`, `sr-latn`, `sv`, `sw`, `ta`, `te`, `tg`, `th`, `tk`, `tr`, `tt`, `udm`, `ug`, `uk`, `ur`, `uz`, `vi`, `zh-hans`, `zh-hant` |  | [Optional] [Defaults to `undefined`] [Enum: af, ar, ar-dz, ast, az, be, bg, bn, br, bs, ca, ckb, cs, cy, da, de, dsb, el, en, en-au, en-gb, eo, es, es-ar, es-co, es-mx, es-ni, es-ve, et, eu, fa, fi, fr, fy, ga, gd, gl, he, hi, hr, hsb, hu, hy, ia, id, ig, io, is, it, ja, ka, kab, kk, km, kn, ko, ky, lb, lt, lv, mk, ml, mn, mr, ms, my, nb, ne, nl, nn, os, pa, pl, pt, pt-br, ro, ru, sk, sl, sq, sr, sr-latn, sv, sw, ta, te, tg, th, tk, tr, tt, udm, ug, uk, ur, uz, vi, zh-hans, zh-hant] |
+
+### Return type
+
+**{ [key: string]: any; }**
+
+### Authorization
+
+[authentik](../README.md#authentik)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/vnd.oai.openapi`, `application/yaml`, `application/vnd.oai.openapi+json`, `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+| **400** |  |  -  |
+| **403** |  |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/ScopeMapping.md

@@ -0,0 +1,53 @@
+
+# ScopeMapping
+
+ScopeMapping Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | string
+`managed` | string
+`name` | string
+`expression` | string
+`component` | string
+`verboseName` | string
+`verboseNamePlural` | string
+`metaModelName` | string
+`scopeName` | string
+`description` | string
+
+## Example
+
+```typescript
+import type { ScopeMapping } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+  "managed": null,
+  "name": null,
+  "expression": null,
+  "component": null,
+  "verboseName": null,
+  "verboseNamePlural": null,
+  "metaModelName": null,
+  "scopeName": null,
+  "description": null,
+} satisfies ScopeMapping
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ScopeMapping
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ScopeMappingRequest.md

@@ -0,0 +1,43 @@
+
+# ScopeMappingRequest
+
+ScopeMapping Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`managed` | string
+`name` | string
+`expression` | string
+`scopeName` | string
+`description` | string
+
+## Example
+
+```typescript
+import type { ScopeMappingRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "managed": null,
+  "name": null,
+  "expression": null,
+  "scopeName": null,
+  "description": null,
+} satisfies ScopeMappingRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ScopeMappingRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SelectableStage.md

@@ -0,0 +1,41 @@
+
+# SelectableStage
+
+Serializer for stages which can be selected by users
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | string
+`name` | string
+`verboseName` | string
+`metaModelName` | string
+
+## Example
+
+```typescript
+import type { SelectableStage } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+  "name": null,
+  "verboseName": null,
+  "metaModelName": null,
+} satisfies SelectableStage
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SelectableStage
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ServiceConnection.md

@@ -0,0 +1,47 @@
+
+# ServiceConnection
+
+ServiceConnection Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | string
+`name` | string
+`local` | boolean
+`component` | string
+`verboseName` | string
+`verboseNamePlural` | string
+`metaModelName` | string
+
+## Example
+
+```typescript
+import type { ServiceConnection } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+  "name": null,
+  "local": null,
+  "component": null,
+  "verboseName": null,
+  "verboseNamePlural": null,
+  "metaModelName": null,
+} satisfies ServiceConnection
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ServiceConnection
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ServiceConnectionState.md

@@ -0,0 +1,37 @@
+
+# ServiceConnectionState
+
+Serializer for Service connection state
+
+## Properties
+
+Name | Type
+------------ | -------------
+`healthy` | boolean
+`version` | string
+
+## Example
+
+```typescript
+import type { ServiceConnectionState } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "healthy": null,
+  "version": null,
+} satisfies ServiceConnectionState
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ServiceConnectionState
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SessionEndChallenge.md

@@ -0,0 +1,51 @@
+
+# SessionEndChallenge
+
+Challenge for ending a session
+
+## Properties
+
+Name | Type
+------------ | -------------
+`flowInfo` | [ContextualFlowInfo](ContextualFlowInfo.md)
+`component` | string
+`responseErrors` | { [key: string]: Array<ErrorDetail>; }
+`pendingUser` | string
+`pendingUserAvatar` | string
+`applicationName` | string
+`applicationLaunchUrl` | string
+`invalidationFlowUrl` | string
+`brandName` | string
+
+## Example
+
+```typescript
+import type { SessionEndChallenge } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "flowInfo": null,
+  "component": null,
+  "responseErrors": null,
+  "pendingUser": null,
+  "pendingUserAvatar": null,
+  "applicationName": null,
+  "applicationLaunchUrl": null,
+  "invalidationFlowUrl": null,
+  "brandName": null,
+} satisfies SessionEndChallenge
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SessionEndChallenge
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SessionUser.md

@@ -0,0 +1,37 @@
+
+# SessionUser
+
+Response for the /user/me endpoint, returns the currently active user (as `user` property) and, if this user is being impersonated, the original user in the `original` property.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`user` | [UserSelf](UserSelf.md)
+`original` | [UserSelf](UserSelf.md)
+
+## Example
+
+```typescript
+import type { SessionUser } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "user": null,
+  "original": null,
+} satisfies SessionUser
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SessionUser
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/Settings.md

@@ -0,0 +1,65 @@
+
+# Settings
+
+Settings Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`avatars` | string
+`defaultUserChangeName` | boolean
+`defaultUserChangeEmail` | boolean
+`defaultUserChangeUsername` | boolean
+`eventRetention` | string
+`reputationLowerLimit` | number
+`reputationUpperLimit` | number
+`footerLinks` | any
+`gdprCompliance` | boolean
+`impersonation` | boolean
+`impersonationRequireReason` | boolean
+`defaultTokenDuration` | string
+`defaultTokenLength` | number
+`paginationDefaultPageSize` | number
+`paginationMaxPageSize` | number
+`flags` | [PatchedSettingsRequestFlags](PatchedSettingsRequestFlags.md)
+
+## Example
+
+```typescript
+import type { Settings } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "avatars": null,
+  "defaultUserChangeName": null,
+  "defaultUserChangeEmail": null,
+  "defaultUserChangeUsername": null,
+  "eventRetention": null,
+  "reputationLowerLimit": null,
+  "reputationUpperLimit": null,
+  "footerLinks": null,
+  "gdprCompliance": null,
+  "impersonation": null,
+  "impersonationRequireReason": null,
+  "defaultTokenDuration": null,
+  "defaultTokenLength": null,
+  "paginationDefaultPageSize": null,
+  "paginationMaxPageSize": null,
+  "flags": null,
+} satisfies Settings
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as Settings
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SettingsRequest.md

@@ -0,0 +1,65 @@
+
+# SettingsRequest
+
+Settings Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`avatars` | string
+`defaultUserChangeName` | boolean
+`defaultUserChangeEmail` | boolean
+`defaultUserChangeUsername` | boolean
+`eventRetention` | string
+`reputationLowerLimit` | number
+`reputationUpperLimit` | number
+`footerLinks` | any
+`gdprCompliance` | boolean
+`impersonation` | boolean
+`impersonationRequireReason` | boolean
+`defaultTokenDuration` | string
+`defaultTokenLength` | number
+`paginationDefaultPageSize` | number
+`paginationMaxPageSize` | number
+`flags` | [PatchedSettingsRequestFlags](PatchedSettingsRequestFlags.md)
+
+## Example
+
+```typescript
+import type { SettingsRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "avatars": null,
+  "defaultUserChangeName": null,
+  "defaultUserChangeEmail": null,
+  "defaultUserChangeUsername": null,
+  "eventRetention": null,
+  "reputationLowerLimit": null,
+  "reputationUpperLimit": null,
+  "footerLinks": null,
+  "gdprCompliance": null,
+  "impersonation": null,
+  "impersonationRequireReason": null,
+  "defaultTokenDuration": null,
+  "defaultTokenLength": null,
+  "paginationDefaultPageSize": null,
+  "paginationMaxPageSize": null,
+  "flags": null,
+} satisfies SettingsRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SettingsRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+