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

package/docs/PatchedDomainRequest.md

@@ -0,0 +1,39 @@
+
+# PatchedDomainRequest
+
+Domain Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`domain` | string
+`isPrimary` | boolean
+`tenant` | string
+
+## Example
+
+```typescript
+import type { PatchedDomainRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "domain": null,
+  "isPrimary": null,
+  "tenant": null,
+} satisfies PatchedDomainRequest
+
+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 PatchedDomainRequest
+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/PatchedDummyPolicyRequest.md

@@ -0,0 +1,43 @@
+
+# PatchedDummyPolicyRequest
+
+Dummy Policy Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`executionLogging` | boolean
+`result` | boolean
+`waitMin` | number
+`waitMax` | number
+
+## Example
+
+```typescript
+import type { PatchedDummyPolicyRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "executionLogging": null,
+  "result": null,
+  "waitMin": null,
+  "waitMax": null,
+} satisfies PatchedDummyPolicyRequest
+
+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 PatchedDummyPolicyRequest
+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/PatchedDummyStageRequest.md

@@ -0,0 +1,37 @@
+
+# PatchedDummyStageRequest
+
+DummyStage Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`throwError` | boolean
+
+## Example
+
+```typescript
+import type { PatchedDummyStageRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "throwError": null,
+} satisfies PatchedDummyStageRequest
+
+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 PatchedDummyStageRequest
+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/PatchedDuoDeviceRequest.md

@@ -0,0 +1,35 @@
+
+# PatchedDuoDeviceRequest
+
+Serializer for Duo authenticator devices
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+
+## Example
+
+```typescript
+import type { PatchedDuoDeviceRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+} satisfies PatchedDuoDeviceRequest
+
+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 PatchedDuoDeviceRequest
+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/PatchedEmailDeviceRequest.md

@@ -0,0 +1,35 @@
+
+# PatchedEmailDeviceRequest
+
+Serializer for email authenticator devices
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+
+## Example
+
+```typescript
+import type { PatchedEmailDeviceRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+} satisfies PatchedEmailDeviceRequest
+
+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 PatchedEmailDeviceRequest
+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/PatchedEmailStageRequest.md

@@ -0,0 +1,65 @@
+
+# PatchedEmailStageRequest
+
+EmailStage Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`useGlobalSettings` | boolean
+`host` | string
+`port` | number
+`username` | string
+`password` | string
+`useTls` | boolean
+`useSsl` | boolean
+`timeout` | number
+`fromAddress` | string
+`tokenExpiry` | string
+`subject` | string
+`template` | string
+`activateUserOnSuccess` | boolean
+`recoveryMaxAttempts` | number
+`recoveryCacheTimeout` | string
+
+## Example
+
+```typescript
+import type { PatchedEmailStageRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "useGlobalSettings": null,
+  "host": null,
+  "port": null,
+  "username": null,
+  "password": null,
+  "useTls": null,
+  "useSsl": null,
+  "timeout": null,
+  "fromAddress": null,
+  "tokenExpiry": null,
+  "subject": null,
+  "template": null,
+  "activateUserOnSuccess": null,
+  "recoveryMaxAttempts": null,
+  "recoveryCacheTimeout": null,
+} satisfies PatchedEmailStageRequest
+
+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 PatchedEmailStageRequest
+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/PatchedEndpointDeviceRequest.md

@@ -0,0 +1,46 @@
+
+# PatchedEndpointDeviceRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`deviceUuid` | string
+`name` | string
+`accessGroup` | string
+`accessGroupObj` | [DeviceAccessGroupRequest](DeviceAccessGroupRequest.md)
+`expiring` | boolean
+`expires` | Date
+`attributes` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { PatchedEndpointDeviceRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "deviceUuid": null,
+  "name": null,
+  "accessGroup": null,
+  "accessGroupObj": null,
+  "expiring": null,
+  "expires": null,
+  "attributes": null,
+} satisfies PatchedEndpointDeviceRequest
+
+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 PatchedEndpointDeviceRequest
+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/PatchedEndpointRequest.md

@@ -0,0 +1,49 @@
+
+# PatchedEndpointRequest
+
+Endpoint Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`provider` | number
+`protocol` | [ProtocolEnum](ProtocolEnum.md)
+`host` | string
+`settings` | { [key: string]: any; }
+`propertyMappings` | Array<string>
+`authMode` | [EndpointAuthModeEnum](EndpointAuthModeEnum.md)
+`maximumConnections` | number
+
+## Example
+
+```typescript
+import type { PatchedEndpointRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "provider": null,
+  "protocol": null,
+  "host": null,
+  "settings": null,
+  "propertyMappings": null,
+  "authMode": null,
+  "maximumConnections": null,
+} satisfies PatchedEndpointRequest
+
+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 PatchedEndpointRequest
+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/PatchedEndpointStageRequest.md

@@ -0,0 +1,39 @@
+
+# PatchedEndpointStageRequest
+
+EndpointStage Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`connector` | string
+`mode` | [StageModeEnum](StageModeEnum.md)
+
+## Example
+
+```typescript
+import type { PatchedEndpointStageRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "connector": null,
+  "mode": null,
+} satisfies PatchedEndpointStageRequest
+
+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 PatchedEndpointStageRequest
+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/PatchedEnrollmentTokenRequest.md

@@ -0,0 +1,42 @@
+
+# PatchedEnrollmentTokenRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`deviceGroup` | string
+`connector` | string
+`name` | string
+`expiring` | boolean
+`expires` | Date
+
+## Example
+
+```typescript
+import type { PatchedEnrollmentTokenRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "deviceGroup": null,
+  "connector": null,
+  "name": null,
+  "expiring": null,
+  "expires": null,
+} satisfies PatchedEnrollmentTokenRequest
+
+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 PatchedEnrollmentTokenRequest
+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/PatchedEventMatcherPolicyRequest.md

@@ -0,0 +1,45 @@
+
+# PatchedEventMatcherPolicyRequest
+
+Event Matcher Policy Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`executionLogging` | boolean
+`action` | [EventActions](EventActions.md)
+`clientIp` | string
+`app` | [AppEnum](AppEnum.md)
+`model` | [ModelEnum](ModelEnum.md)
+
+## Example
+
+```typescript
+import type { PatchedEventMatcherPolicyRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "executionLogging": null,
+  "action": null,
+  "clientIp": null,
+  "app": null,
+  "model": null,
+} satisfies PatchedEventMatcherPolicyRequest
+
+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 PatchedEventMatcherPolicyRequest
+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/PatchedEventRequest.md

@@ -0,0 +1,47 @@
+
+# PatchedEventRequest
+
+Event Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`user` | { [key: string]: any; }
+`action` | [EventActions](EventActions.md)
+`app` | string
+`context` | { [key: string]: any; }
+`clientIp` | string
+`expires` | Date
+`brand` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { PatchedEventRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "user": null,
+  "action": null,
+  "app": null,
+  "context": null,
+  "clientIp": null,
+  "expires": null,
+  "brand": null,
+} satisfies PatchedEventRequest
+
+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 PatchedEventRequest
+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/PatchedExpressionPolicyRequest.md

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

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

@@ -0,0 +1,47 @@
+
+# PatchedFlowStageBindingRequest
+
+FlowStageBinding Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`target` | string
+`stage` | string
+`evaluateOnPlan` | boolean
+`reEvaluatePolicies` | boolean
+`order` | number
+`policyEngineMode` | [PolicyEngineMode](PolicyEngineMode.md)
+`invalidResponseAction` | [InvalidResponseActionEnum](InvalidResponseActionEnum.md)
+
+## Example
+
+```typescript
+import type { PatchedFlowStageBindingRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "target": null,
+  "stage": null,
+  "evaluateOnPlan": null,
+  "reEvaluatePolicies": null,
+  "order": null,
+  "policyEngineMode": null,
+  "invalidResponseAction": null,
+} satisfies PatchedFlowStageBindingRequest
+
+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 PatchedFlowStageBindingRequest
+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)
+
+