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

package/docs/PatchedStaticDeviceRequest.md

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

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

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

@@ -0,0 +1,65 @@
+
+# PatchedTelegramSourceRequest
+
+Source Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`slug` | string
+`enabled` | boolean
+`promoted` | boolean
+`authenticationFlow` | string
+`enrollmentFlow` | string
+`userPropertyMappings` | Array<string>
+`groupPropertyMappings` | Array<string>
+`policyEngineMode` | [PolicyEngineMode](PolicyEngineMode.md)
+`userMatchingMode` | [UserMatchingModeEnum](UserMatchingModeEnum.md)
+`userPathTemplate` | string
+`icon` | string
+`botUsername` | string
+`botToken` | string
+`requestMessageAccess` | boolean
+`preAuthenticationFlow` | string
+
+## Example
+
+```typescript
+import type { PatchedTelegramSourceRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "slug": null,
+  "enabled": null,
+  "promoted": null,
+  "authenticationFlow": null,
+  "enrollmentFlow": null,
+  "userPropertyMappings": null,
+  "groupPropertyMappings": null,
+  "policyEngineMode": null,
+  "userMatchingMode": null,
+  "userPathTemplate": null,
+  "icon": null,
+  "botUsername": null,
+  "botToken": null,
+  "requestMessageAccess": null,
+  "preAuthenticationFlow": null,
+} satisfies PatchedTelegramSourceRequest
+
+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 PatchedTelegramSourceRequest
+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/PatchedTenantRequest.md

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

@@ -0,0 +1,47 @@
+
+# PatchedTokenRequest
+
+Token Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`managed` | string
+`identifier` | string
+`intent` | [IntentEnum](IntentEnum.md)
+`user` | number
+`description` | string
+`expires` | Date
+`expiring` | boolean
+
+## Example
+
+```typescript
+import type { PatchedTokenRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "managed": null,
+  "identifier": null,
+  "intent": null,
+  "user": null,
+  "description": null,
+  "expires": null,
+  "expiring": null,
+} satisfies PatchedTokenRequest
+
+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 PatchedTokenRequest
+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/PatchedUniquePasswordPolicyRequest.md

@@ -0,0 +1,41 @@
+
+# PatchedUniquePasswordPolicyRequest
+
+Password Uniqueness Policy Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`executionLogging` | boolean
+`passwordField` | string
+`numHistoricalPasswords` | number
+
+## Example
+
+```typescript
+import type { PatchedUniquePasswordPolicyRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "executionLogging": null,
+  "passwordField": null,
+  "numHistoricalPasswords": null,
+} satisfies PatchedUniquePasswordPolicyRequest
+
+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 PatchedUniquePasswordPolicyRequest
+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/PatchedUserDeleteStageRequest.md

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

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

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

@@ -0,0 +1,47 @@
+
+# PatchedUserLoginStageRequest
+
+UserLoginStage Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`sessionDuration` | string
+`terminateOtherSessions` | boolean
+`rememberMeOffset` | string
+`networkBinding` | [NetworkBindingEnum](NetworkBindingEnum.md)
+`geoipBinding` | [GeoipBindingEnum](GeoipBindingEnum.md)
+`rememberDevice` | string
+
+## Example
+
+```typescript
+import type { PatchedUserLoginStageRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "sessionDuration": null,
+  "terminateOtherSessions": null,
+  "rememberMeOffset": null,
+  "networkBinding": null,
+  "geoipBinding": null,
+  "rememberDevice": null,
+} satisfies PatchedUserLoginStageRequest
+
+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 PatchedUserLoginStageRequest
+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/PatchedUserLogoutStageRequest.md

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

@@ -0,0 +1,43 @@
+
+# PatchedUserOAuthSourceConnectionRequest
+
+User source connection
+
+## Properties
+
+Name | Type
+------------ | -------------
+`user` | number
+`source` | string
+`identifier` | string
+`accessToken` | string
+`expires` | Date
+
+## Example
+
+```typescript
+import type { PatchedUserOAuthSourceConnectionRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "user": null,
+  "source": null,
+  "identifier": null,
+  "accessToken": null,
+  "expires": null,
+} satisfies PatchedUserOAuthSourceConnectionRequest
+
+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 PatchedUserOAuthSourceConnectionRequest
+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/PatchedUserPlexSourceConnectionRequest.md

@@ -0,0 +1,41 @@
+
+# PatchedUserPlexSourceConnectionRequest
+
+User source connection
+
+## Properties
+
+Name | Type
+------------ | -------------
+`user` | number
+`source` | string
+`identifier` | string
+`plexToken` | string
+
+## Example
+
+```typescript
+import type { PatchedUserPlexSourceConnectionRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "user": null,
+  "source": null,
+  "identifier": null,
+  "plexToken": null,
+} satisfies PatchedUserPlexSourceConnectionRequest
+
+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 PatchedUserPlexSourceConnectionRequest
+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/PatchedUserRequest.md

@@ -0,0 +1,53 @@
+
+# PatchedUserRequest
+
+User Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`username` | string
+`name` | string
+`isActive` | boolean
+`lastLogin` | Date
+`groups` | Array<string>
+`roles` | Array<string>
+`email` | string
+`attributes` | { [key: string]: any; }
+`path` | string
+`type` | [UserTypeEnum](UserTypeEnum.md)
+
+## Example
+
+```typescript
+import type { PatchedUserRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "username": null,
+  "name": null,
+  "isActive": null,
+  "lastLogin": null,
+  "groups": null,
+  "roles": null,
+  "email": null,
+  "attributes": null,
+  "path": null,
+  "type": null,
+} satisfies PatchedUserRequest
+
+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 PatchedUserRequest
+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/PatchedUserSAMLSourceConnectionRequest.md

@@ -0,0 +1,39 @@
+
+# PatchedUserSAMLSourceConnectionRequest
+
+User source connection
+
+## Properties
+
+Name | Type
+------------ | -------------
+`user` | number
+`source` | string
+`identifier` | string
+
+## Example
+
+```typescript
+import type { PatchedUserSAMLSourceConnectionRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "user": null,
+  "source": null,
+  "identifier": null,
+} satisfies PatchedUserSAMLSourceConnectionRequest
+
+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 PatchedUserSAMLSourceConnectionRequest
+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)
+
+