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

package/docs/EventsRequestedEnum.md

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

@@ -0,0 +1,45 @@
+
+# ExpiringBaseGrantModel
+
+Serializer for BaseGrantModel and ExpiringBaseGrant
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | number
+`provider` | [OAuth2Provider](OAuth2Provider.md)
+`user` | [User](User.md)
+`isExpired` | boolean
+`expires` | Date
+`scope` | Array<string>
+
+## Example
+
+```typescript
+import type { ExpiringBaseGrantModel } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+  "provider": null,
+  "user": null,
+  "isExpired": null,
+  "expires": null,
+  "scope": null,
+} satisfies ExpiringBaseGrantModel
+
+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 ExpiringBaseGrantModel
+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/ExpressionPolicy.md

@@ -0,0 +1,51 @@
+
+# ExpressionPolicy
+
+Group Membership Policy Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | string
+`name` | string
+`executionLogging` | boolean
+`component` | string
+`verboseName` | string
+`verboseNamePlural` | string
+`metaModelName` | string
+`boundTo` | number
+`expression` | string
+
+## Example
+
+```typescript
+import type { ExpressionPolicy } 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,
+  "expression": null,
+} satisfies ExpressionPolicy
+
+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 ExpressionPolicy
+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/ExpressionPolicyRequest.md

@@ -0,0 +1,39 @@
+
+# ExpressionPolicyRequest
+
+Group Membership Policy Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`executionLogging` | boolean
+`expression` | string
+
+## Example
+
+```typescript
+import type { ExpressionPolicyRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "executionLogging": null,
+  "expression": null,
+} satisfies ExpressionPolicyRequest
+
+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 ExpressionPolicyRequest
+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/ExtraRoleObjectPermission.md

@@ -0,0 +1,51 @@
+
+# ExtraRoleObjectPermission
+
+Role permission with additional object-related data
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`codename` | string
+`model` | string
+`appLabel` | string
+`objectPk` | string
+`name` | string
+`appLabelVerbose` | string
+`modelVerbose` | string
+`objectDescription` | string
+
+## Example
+
+```typescript
+import type { ExtraRoleObjectPermission } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "codename": null,
+  "model": null,
+  "appLabel": null,
+  "objectPk": null,
+  "name": null,
+  "appLabelVerbose": null,
+  "modelVerbose": null,
+  "objectDescription": null,
+} satisfies ExtraRoleObjectPermission
+
+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 ExtraRoleObjectPermission
+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/FileList.md

@@ -0,0 +1,39 @@
+
+# FileList
+
+Base serializer class which doesn\'t implement create/update methods
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`mimeType` | string
+`url` | string
+
+## Example
+
+```typescript
+import type { FileList } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "mimeType": null,
+  "url": null,
+} satisfies FileList
+
+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 FileList
+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/Flow.md

@@ -0,0 +1,67 @@
+
+# Flow
+
+Flow Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | string
+`policybindingmodelPtrId` | string
+`name` | string
+`slug` | string
+`title` | string
+`designation` | [FlowDesignationEnum](FlowDesignationEnum.md)
+`background` | string
+`backgroundUrl` | string
+`stages` | Array<string>
+`policies` | Array<string>
+`cacheCount` | number
+`policyEngineMode` | [PolicyEngineMode](PolicyEngineMode.md)
+`compatibilityMode` | boolean
+`exportUrl` | string
+`layout` | [FlowLayoutEnum](FlowLayoutEnum.md)
+`deniedAction` | [DeniedActionEnum](DeniedActionEnum.md)
+`authentication` | [AuthenticationEnum](AuthenticationEnum.md)
+
+## Example
+
+```typescript
+import type { Flow } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+  "policybindingmodelPtrId": null,
+  "name": null,
+  "slug": null,
+  "title": null,
+  "designation": null,
+  "background": null,
+  "backgroundUrl": null,
+  "stages": null,
+  "policies": null,
+  "cacheCount": null,
+  "policyEngineMode": null,
+  "compatibilityMode": null,
+  "exportUrl": null,
+  "layout": null,
+  "deniedAction": null,
+  "authentication": null,
+} satisfies Flow
+
+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 Flow
+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/FlowChallengeResponseRequest.md

@@ -0,0 +1,78 @@
+
+# FlowChallengeResponseRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`component` | string
+`code` | string
+`email` | string
+`phoneNumber` | string
+`selectedChallenge` | [DeviceChallengeRequest](DeviceChallengeRequest.md)
+`selectedStage` | string
+`webauthn` | { [key: string]: object; }
+`duo` | number
+`response` | string
+`token` | string
+`uidField` | string
+`password` | string
+`captchaToken` | string
+`passkey` | { [key: string]: object; }
+`to` | string
+`id` | number
+`firstName` | string
+`lastName` | string
+`username` | string
+`photoUrl` | string
+`authDate` | number
+`hash` | string
+`rememberMe` | boolean
+
+## Example
+
+```typescript
+import type { FlowChallengeResponseRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "component": null,
+  "code": null,
+  "email": null,
+  "phoneNumber": null,
+  "selectedChallenge": null,
+  "selectedStage": null,
+  "webauthn": null,
+  "duo": null,
+  "response": null,
+  "token": null,
+  "uidField": null,
+  "password": null,
+  "captchaToken": null,
+  "passkey": null,
+  "to": null,
+  "id": null,
+  "firstName": null,
+  "lastName": null,
+  "username": null,
+  "photoUrl": null,
+  "authDate": null,
+  "hash": null,
+  "rememberMe": null,
+} satisfies FlowChallengeResponseRequest
+
+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 FlowChallengeResponseRequest
+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/FlowDesignationEnum.md

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

@@ -0,0 +1,35 @@
+
+# FlowDiagram
+
+response of the flow\'s diagram action
+
+## Properties
+
+Name | Type
+------------ | -------------
+`diagram` | string
+
+## Example
+
+```typescript
+import type { FlowDiagram } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "diagram": null,
+} satisfies FlowDiagram
+
+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 FlowDiagram
+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/FlowErrorChallenge.md

@@ -0,0 +1,45 @@
+
+# FlowErrorChallenge
+
+Challenge class when an unhandled error occurs during a stage. Normal users are shown an error message, superusers are shown a full stacktrace.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`flowInfo` | [ContextualFlowInfo](ContextualFlowInfo.md)
+`component` | string
+`responseErrors` | { [key: string]: Array<ErrorDetail>; }
+`requestId` | string
+`error` | string
+`traceback` | string
+
+## Example
+
+```typescript
+import type { FlowErrorChallenge } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "flowInfo": null,
+  "component": null,
+  "responseErrors": null,
+  "requestId": null,
+  "error": null,
+  "traceback": null,
+} satisfies FlowErrorChallenge
+
+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 FlowErrorChallenge
+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/FlowImportResult.md

@@ -0,0 +1,37 @@
+
+# FlowImportResult
+
+Logs of an attempted flow import
+
+## Properties
+
+Name | Type
+------------ | -------------
+`logs` | [Array<LogEvent>](LogEvent.md)
+`success` | boolean
+
+## Example
+
+```typescript
+import type { FlowImportResult } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "logs": null,
+  "success": null,
+} satisfies FlowImportResult
+
+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 FlowImportResult
+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/FlowInspection.md

@@ -0,0 +1,39 @@
+
+# FlowInspection
+
+Serializer for inspect endpoint
+
+## Properties
+
+Name | Type
+------------ | -------------
+`plans` | [Array<FlowInspectorPlan>](FlowInspectorPlan.md)
+`currentPlan` | [FlowInspectorPlan](FlowInspectorPlan.md)
+`isCompleted` | boolean
+
+## Example
+
+```typescript
+import type { FlowInspection } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "plans": null,
+  "currentPlan": null,
+  "isCompleted": null,
+} satisfies FlowInspection
+
+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 FlowInspection
+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/FlowInspectorPlan.md

@@ -0,0 +1,41 @@
+
+# FlowInspectorPlan
+
+Serializer for an active FlowPlan
+
+## Properties
+
+Name | Type
+------------ | -------------
+`currentStage` | [FlowStageBinding](FlowStageBinding.md)
+`nextPlannedStage` | [FlowStageBinding](FlowStageBinding.md)
+`planContext` | { [key: string]: any; }
+`sessionId` | string
+
+## Example
+
+```typescript
+import type { FlowInspectorPlan } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "currentStage": null,
+  "nextPlannedStage": null,
+  "planContext": null,
+  "sessionId": null,
+} satisfies FlowInspectorPlan
+
+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 FlowInspectorPlan
+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/FlowLayoutEnum.md

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