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

package/docs/Policy.md

@@ -0,0 +1,49 @@
+
+# Policy
+
+Policy Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | string
+`name` | string
+`executionLogging` | boolean
+`component` | string
+`verboseName` | string
+`verboseNamePlural` | string
+`metaModelName` | string
+`boundTo` | number
+
+## Example
+
+```typescript
+import type { Policy } 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,
+} satisfies Policy
+
+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 Policy
+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/PolicyBinding.md

@@ -0,0 +1,59 @@
+
+# PolicyBinding
+
+PolicyBinding Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | string
+`policy` | string
+`group` | string
+`user` | number
+`policyObj` | [Policy](Policy.md)
+`groupObj` | [PartialGroup](PartialGroup.md)
+`userObj` | [PartialUser](PartialUser.md)
+`target` | string
+`negate` | boolean
+`enabled` | boolean
+`order` | number
+`timeout` | number
+`failureResult` | boolean
+
+## Example
+
+```typescript
+import type { PolicyBinding } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+  "policy": null,
+  "group": null,
+  "user": null,
+  "policyObj": null,
+  "groupObj": null,
+  "userObj": null,
+  "target": null,
+  "negate": null,
+  "enabled": null,
+  "order": null,
+  "timeout": null,
+  "failureResult": null,
+} satisfies PolicyBinding
+
+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 PolicyBinding
+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/PolicyBindingRequest.md

@@ -0,0 +1,51 @@
+
+# PolicyBindingRequest
+
+PolicyBinding Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`policy` | string
+`group` | string
+`user` | number
+`target` | string
+`negate` | boolean
+`enabled` | boolean
+`order` | number
+`timeout` | number
+`failureResult` | boolean
+
+## Example
+
+```typescript
+import type { PolicyBindingRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "policy": null,
+  "group": null,
+  "user": null,
+  "target": null,
+  "negate": null,
+  "enabled": null,
+  "order": null,
+  "timeout": null,
+  "failureResult": null,
+} satisfies PolicyBindingRequest
+
+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 PolicyBindingRequest
+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/PolicyEngineMode.md

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

@@ -0,0 +1,37 @@
+
+# PolicyTestRequest
+
+Test policy execution for a user with context
+
+## Properties
+
+Name | Type
+------------ | -------------
+`user` | number
+`context` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { PolicyTestRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "user": null,
+  "context": null,
+} satisfies PolicyTestRequest
+
+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 PolicyTestRequest
+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/PolicyTestResult.md

@@ -0,0 +1,39 @@
+
+# PolicyTestResult
+
+result of a policy test
+
+## Properties
+
+Name | Type
+------------ | -------------
+`passing` | boolean
+`messages` | Array<string>
+`logMessages` | [Array<LogEvent>](LogEvent.md)
+
+## Example
+
+```typescript
+import type { PolicyTestResult } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "passing": null,
+  "messages": null,
+  "logMessages": null,
+} satisfies PolicyTestResult
+
+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 PolicyTestResult
+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/Process.md

@@ -0,0 +1,38 @@
+
+# Process
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`name` | string
+`user` | string
+
+## Example
+
+```typescript
+import type { Process } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "user": null,
+} satisfies Process
+
+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 Process
+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/ProcessRequest.md

@@ -0,0 +1,38 @@
+
+# ProcessRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`name` | string
+`user` | string
+
+## Example
+
+```typescript
+import type { ProcessRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "user": null,
+} satisfies ProcessRequest
+
+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 ProcessRequest
+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/Prompt.md

@@ -0,0 +1,59 @@
+
+# Prompt
+
+Prompt Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | string
+`name` | string
+`fieldKey` | string
+`label` | string
+`type` | [PromptTypeEnum](PromptTypeEnum.md)
+`required` | boolean
+`placeholder` | string
+`initialValue` | string
+`order` | number
+`promptStagesObj` | [Array<PromptStage>](PromptStage.md)
+`subText` | string
+`placeholderExpression` | boolean
+`initialValueExpression` | boolean
+
+## Example
+
+```typescript
+import type { Prompt } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+  "name": null,
+  "fieldKey": null,
+  "label": null,
+  "type": null,
+  "required": null,
+  "placeholder": null,
+  "initialValue": null,
+  "order": null,
+  "promptStagesObj": null,
+  "subText": null,
+  "placeholderExpression": null,
+  "initialValueExpression": null,
+} satisfies Prompt
+
+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 Prompt
+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/PromptChallenge.md

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

@@ -0,0 +1,35 @@
+
+# PromptChallengeResponseRequest
+
+Validate response, fields are dynamically created based on the stage
+
+## Properties
+
+Name | Type
+------------ | -------------
+`component` | string
+
+## Example
+
+```typescript
+import type { PromptChallengeResponseRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "component": null,
+} satisfies PromptChallengeResponseRequest
+
+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 PromptChallengeResponseRequest
+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/PromptChoice.md

@@ -0,0 +1,37 @@
+
+# PromptChoice
+
+Serializer for a single Choice field
+
+## Properties
+
+Name | Type
+------------ | -------------
+`value` | string
+`label` | string
+
+## Example
+
+```typescript
+import type { PromptChoice } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "value": null,
+  "label": null,
+} satisfies PromptChoice
+
+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 PromptChoice
+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/PromptRequest.md

@@ -0,0 +1,55 @@
+
+# PromptRequest
+
+Prompt Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`fieldKey` | string
+`label` | string
+`type` | [PromptTypeEnum](PromptTypeEnum.md)
+`required` | boolean
+`placeholder` | string
+`initialValue` | string
+`order` | number
+`subText` | string
+`placeholderExpression` | boolean
+`initialValueExpression` | boolean
+
+## Example
+
+```typescript
+import type { PromptRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "fieldKey": null,
+  "label": null,
+  "type": null,
+  "required": null,
+  "placeholder": null,
+  "initialValue": null,
+  "order": null,
+  "subText": null,
+  "placeholderExpression": null,
+  "initialValueExpression": null,
+} satisfies PromptRequest
+
+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 PromptRequest
+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/PromptStage.md

@@ -0,0 +1,51 @@
+
+# PromptStage
+
+PromptStage Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | string
+`name` | string
+`component` | string
+`verboseName` | string
+`verboseNamePlural` | string
+`metaModelName` | string
+`flowSet` | [Array<FlowSet>](FlowSet.md)
+`fields` | Array<string>
+`validationPolicies` | Array<string>
+
+## Example
+
+```typescript
+import type { PromptStage } 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,
+  "fields": null,
+  "validationPolicies": null,
+} satisfies PromptStage
+
+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 PromptStage
+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/PromptStageRequest.md

@@ -0,0 +1,39 @@
+
+# PromptStageRequest
+
+PromptStage Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`fields` | Array<string>
+`validationPolicies` | Array<string>
+
+## Example
+
+```typescript
+import type { PromptStageRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "fields": null,
+  "validationPolicies": null,
+} satisfies PromptStageRequest
+
+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 PromptStageRequest
+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/PromptTypeEnum.md

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