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

package/docs/PatchedGeoIPPolicyRequest.md

@@ -0,0 +1,53 @@
+
+# PatchedGeoIPPolicyRequest
+
+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 { PatchedGeoIPPolicyRequest } 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 PatchedGeoIPPolicyRequest
+
+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 PatchedGeoIPPolicyRequest
+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/PatchedGoogleEndpointDeviceRequest.md

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

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

@@ -0,0 +1,61 @@
+
+# PatchedGoogleWorkspaceProviderRequest
+
+GoogleWorkspaceProvider Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`propertyMappings` | Array<string>
+`propertyMappingsGroup` | Array<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 { PatchedGoogleWorkspaceProviderRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "propertyMappings": null,
+  "propertyMappingsGroup": null,
+  "delegatedSubject": null,
+  "credentials": null,
+  "scopes": null,
+  "excludeUsersServiceAccount": null,
+  "filterGroup": null,
+  "userDeleteAction": null,
+  "groupDeleteAction": null,
+  "defaultGroupEmailDomain": null,
+  "syncPageSize": null,
+  "syncPageTimeout": null,
+  "dryRun": null,
+} satisfies PatchedGoogleWorkspaceProviderRequest
+
+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 PatchedGoogleWorkspaceProviderRequest
+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/PatchedGroupKerberosSourceConnectionRequest.md

@@ -0,0 +1,39 @@
+
+# PatchedGroupKerberosSourceConnectionRequest
+
+Group Source Connection
+
+## Properties
+
+Name | Type
+------------ | -------------
+`group` | string
+`source` | string
+`identifier` | string
+
+## Example
+
+```typescript
+import type { PatchedGroupKerberosSourceConnectionRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "group": null,
+  "source": null,
+  "identifier": null,
+} satisfies PatchedGroupKerberosSourceConnectionRequest
+
+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 PatchedGroupKerberosSourceConnectionRequest
+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/PatchedGroupLDAPSourceConnectionRequest.md

@@ -0,0 +1,39 @@
+
+# PatchedGroupLDAPSourceConnectionRequest
+
+Group Source Connection
+
+## Properties
+
+Name | Type
+------------ | -------------
+`group` | string
+`source` | string
+`identifier` | string
+
+## Example
+
+```typescript
+import type { PatchedGroupLDAPSourceConnectionRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "group": null,
+  "source": null,
+  "identifier": null,
+} satisfies PatchedGroupLDAPSourceConnectionRequest
+
+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 PatchedGroupLDAPSourceConnectionRequest
+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/PatchedGroupOAuthSourceConnectionRequest.md

@@ -0,0 +1,39 @@
+
+# PatchedGroupOAuthSourceConnectionRequest
+
+Group Source Connection
+
+## Properties
+
+Name | Type
+------------ | -------------
+`group` | string
+`source` | string
+`identifier` | string
+
+## Example
+
+```typescript
+import type { PatchedGroupOAuthSourceConnectionRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "group": null,
+  "source": null,
+  "identifier": null,
+} satisfies PatchedGroupOAuthSourceConnectionRequest
+
+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 PatchedGroupOAuthSourceConnectionRequest
+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/PatchedGroupPlexSourceConnectionRequest.md

@@ -0,0 +1,39 @@
+
+# PatchedGroupPlexSourceConnectionRequest
+
+Group Source Connection
+
+## Properties
+
+Name | Type
+------------ | -------------
+`group` | string
+`source` | string
+`identifier` | string
+
+## Example
+
+```typescript
+import type { PatchedGroupPlexSourceConnectionRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "group": null,
+  "source": null,
+  "identifier": null,
+} satisfies PatchedGroupPlexSourceConnectionRequest
+
+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 PatchedGroupPlexSourceConnectionRequest
+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/PatchedGroupRequest.md

@@ -0,0 +1,45 @@
+
+# PatchedGroupRequest
+
+Group Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`isSuperuser` | boolean
+`parents` | Array<string>
+`users` | Array<number>
+`attributes` | { [key: string]: any; }
+`roles` | Array<string>
+
+## Example
+
+```typescript
+import type { PatchedGroupRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "isSuperuser": null,
+  "parents": null,
+  "users": null,
+  "attributes": null,
+  "roles": null,
+} satisfies PatchedGroupRequest
+
+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 PatchedGroupRequest
+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/PatchedGroupSAMLSourceConnectionRequest.md

@@ -0,0 +1,39 @@
+
+# PatchedGroupSAMLSourceConnectionRequest
+
+Group Source Connection
+
+## Properties
+
+Name | Type
+------------ | -------------
+`group` | string
+`source` | string
+`identifier` | string
+
+## Example
+
+```typescript
+import type { PatchedGroupSAMLSourceConnectionRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "group": null,
+  "source": null,
+  "identifier": null,
+} satisfies PatchedGroupSAMLSourceConnectionRequest
+
+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 PatchedGroupSAMLSourceConnectionRequest
+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/PatchedGroupSourceConnectionRequest.md

@@ -0,0 +1,39 @@
+
+# PatchedGroupSourceConnectionRequest
+
+Group Source Connection
+
+## Properties
+
+Name | Type
+------------ | -------------
+`group` | string
+`source` | string
+`identifier` | string
+
+## Example
+
+```typescript
+import type { PatchedGroupSourceConnectionRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "group": null,
+  "source": null,
+  "identifier": null,
+} satisfies PatchedGroupSourceConnectionRequest
+
+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 PatchedGroupSourceConnectionRequest
+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/PatchedGroupTelegramSourceConnectionRequest.md

@@ -0,0 +1,39 @@
+
+# PatchedGroupTelegramSourceConnectionRequest
+
+Group Source Connection
+
+## Properties
+
+Name | Type
+------------ | -------------
+`group` | string
+`source` | string
+`identifier` | string
+
+## Example
+
+```typescript
+import type { PatchedGroupTelegramSourceConnectionRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "group": null,
+  "source": null,
+  "identifier": null,
+} satisfies PatchedGroupTelegramSourceConnectionRequest
+
+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 PatchedGroupTelegramSourceConnectionRequest
+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/PatchedIdentificationStageRequest.md

@@ -0,0 +1,61 @@
+
+# PatchedIdentificationStageRequest
+
+IdentificationStage Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`userFields` | [Array<UserFieldsEnum>](UserFieldsEnum.md)
+`passwordStage` | string
+`captchaStage` | string
+`caseInsensitiveMatching` | boolean
+`showMatchedUser` | boolean
+`enrollmentFlow` | string
+`recoveryFlow` | string
+`passwordlessFlow` | string
+`sources` | Array<string>
+`showSourceLabels` | boolean
+`pretendUserExists` | boolean
+`enableRememberMe` | boolean
+`webauthnStage` | string
+
+## Example
+
+```typescript
+import type { PatchedIdentificationStageRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "userFields": null,
+  "passwordStage": null,
+  "captchaStage": null,
+  "caseInsensitiveMatching": null,
+  "showMatchedUser": null,
+  "enrollmentFlow": null,
+  "recoveryFlow": null,
+  "passwordlessFlow": null,
+  "sources": null,
+  "showSourceLabels": null,
+  "pretendUserExists": null,
+  "enableRememberMe": null,
+  "webauthnStage": null,
+} satisfies PatchedIdentificationStageRequest
+
+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 PatchedIdentificationStageRequest
+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/PatchedInitialPermissionsRequest.md

@@ -0,0 +1,39 @@
+
+# PatchedInitialPermissionsRequest
+
+InitialPermissions serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`role` | string
+`permissions` | Array<number>
+
+## Example
+
+```typescript
+import type { PatchedInitialPermissionsRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "role": null,
+  "permissions": null,
+} satisfies PatchedInitialPermissionsRequest
+
+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 PatchedInitialPermissionsRequest
+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/PatchedInvitationRequest.md

@@ -0,0 +1,43 @@
+
+# PatchedInvitationRequest
+
+Invitation Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`expires` | Date
+`fixedData` | { [key: string]: any; }
+`singleUse` | boolean
+`flow` | string
+
+## Example
+
+```typescript
+import type { PatchedInvitationRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "expires": null,
+  "fixedData": null,
+  "singleUse": null,
+  "flow": null,
+} satisfies PatchedInvitationRequest
+
+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 PatchedInvitationRequest
+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)
+
+