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

package/docs/RedirectChallenge.md

@@ -0,0 +1,41 @@
+
+# RedirectChallenge
+
+Challenge type to redirect the client
+
+## Properties
+
+Name | Type
+------------ | -------------
+`flowInfo` | [ContextualFlowInfo](ContextualFlowInfo.md)
+`component` | string
+`responseErrors` | { [key: string]: Array<ErrorDetail>; }
+`to` | string
+
+## Example
+
+```typescript
+import type { RedirectChallenge } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "flowInfo": null,
+  "component": null,
+  "responseErrors": null,
+  "to": null,
+} satisfies RedirectChallenge
+
+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 RedirectChallenge
+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/RedirectChallengeResponseRequest.md

@@ -0,0 +1,37 @@
+
+# RedirectChallengeResponseRequest
+
+Redirect challenge response
+
+## Properties
+
+Name | Type
+------------ | -------------
+`component` | string
+`to` | string
+
+## Example
+
+```typescript
+import type { RedirectChallengeResponseRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "component": null,
+  "to": null,
+} satisfies RedirectChallengeResponseRequest
+
+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 RedirectChallengeResponseRequest
+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/RedirectStage.md

@@ -0,0 +1,55 @@
+
+# RedirectStage
+
+RedirectStage Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | string
+`name` | string
+`component` | string
+`verboseName` | string
+`verboseNamePlural` | string
+`metaModelName` | string
+`flowSet` | [Array<FlowSet>](FlowSet.md)
+`keepContext` | boolean
+`mode` | [RedirectStageModeEnum](RedirectStageModeEnum.md)
+`targetStatic` | string
+`targetFlow` | string
+
+## Example
+
+```typescript
+import type { RedirectStage } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+  "name": null,
+  "component": null,
+  "verboseName": null,
+  "verboseNamePlural": null,
+  "metaModelName": null,
+  "flowSet": null,
+  "keepContext": null,
+  "mode": null,
+  "targetStatic": null,
+  "targetFlow": null,
+} satisfies RedirectStage
+
+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 RedirectStage
+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/RedirectStageModeEnum.md

@@ -0,0 +1,32 @@
+
+# RedirectStageModeEnum
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { RedirectStageModeEnum } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies RedirectStageModeEnum
+
+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 RedirectStageModeEnum
+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/RedirectStageRequest.md

@@ -0,0 +1,43 @@
+
+# RedirectStageRequest
+
+RedirectStage Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`keepContext` | boolean
+`mode` | [RedirectStageModeEnum](RedirectStageModeEnum.md)
+`targetStatic` | string
+`targetFlow` | string
+
+## Example
+
+```typescript
+import type { RedirectStageRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "keepContext": null,
+  "mode": null,
+  "targetStatic": null,
+  "targetFlow": null,
+} satisfies RedirectStageRequest
+
+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 RedirectStageRequest
+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/RedirectURI.md

@@ -0,0 +1,37 @@
+
+# RedirectURI
+
+A single allowed redirect URI entry
+
+## Properties
+
+Name | Type
+------------ | -------------
+`matchingMode` | [MatchingModeEnum](MatchingModeEnum.md)
+`url` | string
+
+## Example
+
+```typescript
+import type { RedirectURI } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "matchingMode": null,
+  "url": null,
+} satisfies RedirectURI
+
+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 RedirectURI
+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/RedirectURIRequest.md

@@ -0,0 +1,37 @@
+
+# RedirectURIRequest
+
+A single allowed redirect URI entry
+
+## Properties
+
+Name | Type
+------------ | -------------
+`matchingMode` | [MatchingModeEnum](MatchingModeEnum.md)
+`url` | string
+
+## Example
+
+```typescript
+import type { RedirectURIRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "matchingMode": null,
+  "url": null,
+} satisfies RedirectURIRequest
+
+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 RedirectURIRequest
+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/RelatedGroup.md

@@ -0,0 +1,43 @@
+
+# RelatedGroup
+
+Stripped down group serializer to show relevant children/parents for groups
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | string
+`name` | string
+`isSuperuser` | boolean
+`attributes` | { [key: string]: any; }
+`groupUuid` | string
+
+## Example
+
+```typescript
+import type { RelatedGroup } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+  "name": null,
+  "isSuperuser": null,
+  "attributes": null,
+  "groupUuid": null,
+} satisfies RelatedGroup
+
+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 RelatedGroup
+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/ReportsApi.md

@@ -0,0 +1,233 @@
+# ReportsApi
+
+All URIs are relative to */api/v3*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**reportsExportsDestroy**](ReportsApi.md#reportsexportsdestroy) | **DELETE** /reports/exports/{id}/ |  |
+| [**reportsExportsList**](ReportsApi.md#reportsexportslist) | **GET** /reports/exports/ |  |
+| [**reportsExportsRetrieve**](ReportsApi.md#reportsexportsretrieve) | **GET** /reports/exports/{id}/ |  |
+
+
+
+## reportsExportsDestroy
+
+> reportsExportsDestroy(id)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReportsApi,
+} from '@goauthentik/api';
+import type { ReportsExportsDestroyRequest } 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 ReportsApi(config);
+
+  const body = {
+    // string | A UUID string identifying this Data Export.
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies ReportsExportsDestroyRequest;
+
+  try {
+    const data = await api.reportsExportsDestroy(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | A UUID string identifying this Data Export. | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[authentik](../README.md#authentik)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | No response body |  -  |
+| **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)
+
+
+## reportsExportsList
+
+> PaginatedDataExportList reportsExportsList(ordering, page, pageSize, search)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReportsApi,
+} from '@goauthentik/api';
+import type { ReportsExportsListRequest } 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 ReportsApi(config);
+
+  const body = {
+    // string | Which field to use when ordering the results. (optional)
+    ordering: ordering_example,
+    // number | A page number within the paginated result set. (optional)
+    page: 56,
+    // number | Number of results to return per page. (optional)
+    pageSize: 56,
+    // string | A search term. (optional)
+    search: search_example,
+  } satisfies ReportsExportsListRequest;
+
+  try {
+    const data = await api.reportsExportsList(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **ordering** | `string` | Which field to use when ordering the results. | [Optional] [Defaults to `undefined`] |
+| **page** | `number` | A page number within the paginated result set. | [Optional] [Defaults to `undefined`] |
+| **pageSize** | `number` | Number of results to return per page. | [Optional] [Defaults to `undefined`] |
+| **search** | `string` | A search term. | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**PaginatedDataExportList**](PaginatedDataExportList.md)
+
+### Authorization
+
+[authentik](../README.md#authentik)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `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)
+
+
+## reportsExportsRetrieve
+
+> DataExport reportsExportsRetrieve(id)
+
+
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReportsApi,
+} from '@goauthentik/api';
+import type { ReportsExportsRetrieveRequest } 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 ReportsApi(config);
+
+  const body = {
+    // string | A UUID string identifying this Data Export.
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies ReportsExportsRetrieveRequest;
+
+  try {
+    const data = await api.reportsExportsRetrieve(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` | A UUID string identifying this Data Export. | [Defaults to `undefined`] |
+
+### Return type
+
+[**DataExport**](DataExport.md)
+
+### Authorization
+
+[authentik](../README.md#authentik)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `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/Reputation.md

@@ -0,0 +1,47 @@
+
+# Reputation
+
+Reputation Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | string
+`identifier` | string
+`ip` | string
+`ipGeoData` | { [key: string]: any; }
+`ipAsnData` | { [key: string]: any; }
+`score` | number
+`updated` | Date
+
+## Example
+
+```typescript
+import type { Reputation } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+  "identifier": null,
+  "ip": null,
+  "ipGeoData": null,
+  "ipAsnData": null,
+  "score": null,
+  "updated": null,
+} satisfies Reputation
+
+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 Reputation
+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/ReputationPolicy.md

@@ -0,0 +1,55 @@
+
+# ReputationPolicy
+
+Reputation Policy Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | string
+`name` | string
+`executionLogging` | boolean
+`component` | string
+`verboseName` | string
+`verboseNamePlural` | string
+`metaModelName` | string
+`boundTo` | number
+`checkIp` | boolean
+`checkUsername` | boolean
+`threshold` | number
+
+## Example
+
+```typescript
+import type { ReputationPolicy } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+  "name": null,
+  "executionLogging": null,
+  "component": null,
+  "verboseName": null,
+  "verboseNamePlural": null,
+  "metaModelName": null,
+  "boundTo": null,
+  "checkIp": null,
+  "checkUsername": null,
+  "threshold": null,
+} satisfies ReputationPolicy
+
+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 ReputationPolicy
+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/ReputationPolicyRequest.md

@@ -0,0 +1,43 @@
+
+# ReputationPolicyRequest
+
+Reputation Policy Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`executionLogging` | boolean
+`checkIp` | boolean
+`checkUsername` | boolean
+`threshold` | number
+
+## Example
+
+```typescript
+import type { ReputationPolicyRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "executionLogging": null,
+  "checkIp": null,
+  "checkUsername": null,
+  "threshold": null,
+} satisfies ReputationPolicyRequest
+
+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 ReputationPolicyRequest
+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)
+
+