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

package/docs/FooterLink.md

@@ -0,0 +1,37 @@
+
+# FooterLink
+
+Links returned in Config API
+
+## Properties
+
+Name | Type
+------------ | -------------
+`href` | string
+`name` | string
+
+## Example
+
+```typescript
+import type { FooterLink } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "href": null,
+  "name": null,
+} satisfies FooterLink
+
+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 FooterLink
+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/FrameChallenge.md

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

@@ -0,0 +1,35 @@
+
+# FrameChallengeResponseRequest
+
+Base class for all challenge responses
+
+## Properties
+
+Name | Type
+------------ | -------------
+`component` | string
+
+## Example
+
+```typescript
+import type { FrameChallengeResponseRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "component": null,
+} satisfies FrameChallengeResponseRequest
+
+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 FrameChallengeResponseRequest
+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/GenericError.md

@@ -0,0 +1,37 @@
+
+# GenericError
+
+Generic API Error
+
+## Properties
+
+Name | Type
+------------ | -------------
+`detail` | string
+`code` | string
+
+## Example
+
+```typescript
+import type { GenericError } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "detail": null,
+  "code": null,
+} satisfies GenericError
+
+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 GenericError
+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/GeoIPPolicy.md

@@ -0,0 +1,67 @@
+
+# GeoIPPolicy
+
+GeoIP Policy Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | string
+`name` | string
+`executionLogging` | boolean
+`component` | string
+`verboseName` | string
+`verboseNamePlural` | string
+`metaModelName` | string
+`boundTo` | number
+`asns` | Array<number>
+`countries` | [Array<CountryCodeEnum>](CountryCodeEnum.md)
+`countriesObj` | [Array<DetailedCountryField>](DetailedCountryField.md)
+`checkHistoryDistance` | boolean
+`historyMaxDistanceKm` | number
+`distanceToleranceKm` | number
+`historyLoginCount` | number
+`checkImpossibleTravel` | boolean
+`impossibleToleranceKm` | number
+
+## Example
+
+```typescript
+import type { GeoIPPolicy } 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,
+  "asns": null,
+  "countries": null,
+  "countriesObj": null,
+  "checkHistoryDistance": null,
+  "historyMaxDistanceKm": null,
+  "distanceToleranceKm": null,
+  "historyLoginCount": null,
+  "checkImpossibleTravel": null,
+  "impossibleToleranceKm": null,
+} satisfies GeoIPPolicy
+
+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 GeoIPPolicy
+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/GeoIPPolicyRequest.md

@@ -0,0 +1,53 @@
+
+# GeoIPPolicyRequest
+
+GeoIP Policy Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`executionLogging` | boolean
+`asns` | Array<number>
+`countries` | [Array<CountryCodeEnum>](CountryCodeEnum.md)
+`checkHistoryDistance` | boolean
+`historyMaxDistanceKm` | number
+`distanceToleranceKm` | number
+`historyLoginCount` | number
+`checkImpossibleTravel` | boolean
+`impossibleToleranceKm` | number
+
+## Example
+
+```typescript
+import type { GeoIPPolicyRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "executionLogging": null,
+  "asns": null,
+  "countries": null,
+  "checkHistoryDistance": null,
+  "historyMaxDistanceKm": null,
+  "distanceToleranceKm": null,
+  "historyLoginCount": null,
+  "checkImpossibleTravel": null,
+  "impossibleToleranceKm": null,
+} satisfies GeoIPPolicyRequest
+
+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 GeoIPPolicyRequest
+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/GeoipBindingEnum.md

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

@@ -0,0 +1,52 @@
+
+# GlobalTaskStatus
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`queued` | number
+`consumed` | number
+`preprocess` | number
+`running` | number
+`postprocess` | number
+`rejected` | number
+`done` | number
+`info` | number
+`warning` | number
+`error` | number
+
+## Example
+
+```typescript
+import type { GlobalTaskStatus } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "queued": null,
+  "consumed": null,
+  "preprocess": null,
+  "running": null,
+  "postprocess": null,
+  "rejected": null,
+  "done": null,
+  "info": null,
+  "warning": null,
+  "error": null,
+} satisfies GlobalTaskStatus
+
+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 GlobalTaskStatus
+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/GoogleEndpointDevice.md

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

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

@@ -0,0 +1,75 @@
+
+# GoogleWorkspaceProvider
+
+GoogleWorkspaceProvider Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | number
+`name` | string
+`propertyMappings` | Array<string>
+`propertyMappingsGroup` | Array<string>
+`component` | string
+`assignedBackchannelApplicationSlug` | string
+`assignedBackchannelApplicationName` | string
+`verboseName` | string
+`verboseNamePlural` | string
+`metaModelName` | string
+`delegatedSubject` | string
+`credentials` | { [key: string]: any; }
+`scopes` | string
+`excludeUsersServiceAccount` | boolean
+`filterGroup` | string
+`userDeleteAction` | [OutgoingSyncDeleteAction](OutgoingSyncDeleteAction.md)
+`groupDeleteAction` | [OutgoingSyncDeleteAction](OutgoingSyncDeleteAction.md)
+`defaultGroupEmailDomain` | string
+`syncPageSize` | number
+`syncPageTimeout` | string
+`dryRun` | boolean
+
+## Example
+
+```typescript
+import type { GoogleWorkspaceProvider } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+  "name": null,
+  "propertyMappings": null,
+  "propertyMappingsGroup": null,
+  "component": null,
+  "assignedBackchannelApplicationSlug": null,
+  "assignedBackchannelApplicationName": null,
+  "verboseName": null,
+  "verboseNamePlural": null,
+  "metaModelName": null,
+  "delegatedSubject": null,
+  "credentials": null,
+  "scopes": null,
+  "excludeUsersServiceAccount": null,
+  "filterGroup": null,
+  "userDeleteAction": null,
+  "groupDeleteAction": null,
+  "defaultGroupEmailDomain": null,
+  "syncPageSize": null,
+  "syncPageTimeout": null,
+  "dryRun": null,
+} satisfies GoogleWorkspaceProvider
+
+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 GoogleWorkspaceProvider
+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/GoogleWorkspaceProviderGroup.md

@@ -0,0 +1,45 @@
+
+# GoogleWorkspaceProviderGroup
+
+GoogleWorkspaceProviderGroup Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`googleId` | string
+`group` | string
+`groupObj` | [PartialGroup](PartialGroup.md)
+`provider` | number
+`attributes` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { GoogleWorkspaceProviderGroup } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "googleId": null,
+  "group": null,
+  "groupObj": null,
+  "provider": null,
+  "attributes": null,
+} satisfies GoogleWorkspaceProviderGroup
+
+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 GoogleWorkspaceProviderGroup
+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/GoogleWorkspaceProviderGroupRequest.md

@@ -0,0 +1,39 @@
+
+# GoogleWorkspaceProviderGroupRequest
+
+GoogleWorkspaceProviderGroup Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`googleId` | string
+`group` | string
+`provider` | number
+
+## Example
+
+```typescript
+import type { GoogleWorkspaceProviderGroupRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "googleId": null,
+  "group": null,
+  "provider": null,
+} satisfies GoogleWorkspaceProviderGroupRequest
+
+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 GoogleWorkspaceProviderGroupRequest
+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/GoogleWorkspaceProviderMapping.md

@@ -0,0 +1,49 @@
+
+# GoogleWorkspaceProviderMapping
+
+GoogleWorkspaceProviderMapping Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | string
+`managed` | string
+`name` | string
+`expression` | string
+`component` | string
+`verboseName` | string
+`verboseNamePlural` | string
+`metaModelName` | string
+
+## Example
+
+```typescript
+import type { GoogleWorkspaceProviderMapping } 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,
+} satisfies GoogleWorkspaceProviderMapping
+
+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 GoogleWorkspaceProviderMapping
+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/GoogleWorkspaceProviderMappingRequest.md

@@ -0,0 +1,39 @@
+
+# GoogleWorkspaceProviderMappingRequest
+
+GoogleWorkspaceProviderMapping Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`managed` | string
+`name` | string
+`expression` | string
+
+## Example
+
+```typescript
+import type { GoogleWorkspaceProviderMappingRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "managed": null,
+  "name": null,
+  "expression": null,
+} satisfies GoogleWorkspaceProviderMappingRequest
+
+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 GoogleWorkspaceProviderMappingRequest
+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)
+
+