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

package/docs/UserServiceAccountResponse.md

@@ -0,0 +1,42 @@
+
+# UserServiceAccountResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`username` | string
+`token` | string
+`userUid` | string
+`userPk` | number
+`groupPk` | string
+
+## Example
+
+```typescript
+import type { UserServiceAccountResponse } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "username": null,
+  "token": null,
+  "userUid": null,
+  "userPk": null,
+  "groupPk": null,
+} satisfies UserServiceAccountResponse
+
+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 UserServiceAccountResponse
+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/UserSetting.md

@@ -0,0 +1,43 @@
+
+# UserSetting
+
+Serializer for User settings for stages and sources
+
+## Properties
+
+Name | Type
+------------ | -------------
+`objectUid` | string
+`component` | string
+`title` | string
+`configureUrl` | string
+`iconUrl` | string
+
+## Example
+
+```typescript
+import type { UserSetting } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "objectUid": null,
+  "component": null,
+  "title": null,
+  "configureUrl": null,
+  "iconUrl": null,
+} satisfies UserSetting
+
+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 UserSetting
+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/UserSourceConnection.md

@@ -0,0 +1,47 @@
+
+# UserSourceConnection
+
+User source connection
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | number
+`user` | number
+`source` | string
+`sourceObj` | [Source](Source.md)
+`identifier` | string
+`created` | Date
+`lastUpdated` | Date
+
+## Example
+
+```typescript
+import type { UserSourceConnection } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+  "user": null,
+  "source": null,
+  "sourceObj": null,
+  "identifier": null,
+  "created": null,
+  "lastUpdated": null,
+} satisfies UserSourceConnection
+
+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 UserSourceConnection
+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/UserSourceConnectionRequest.md

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

@@ -0,0 +1,47 @@
+
+# UserTelegramSourceConnection
+
+User source connection
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | number
+`user` | number
+`source` | string
+`sourceObj` | [Source](Source.md)
+`identifier` | string
+`created` | Date
+`lastUpdated` | Date
+
+## Example
+
+```typescript
+import type { UserTelegramSourceConnection } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+  "user": null,
+  "source": null,
+  "sourceObj": null,
+  "identifier": null,
+  "created": null,
+  "lastUpdated": null,
+} satisfies UserTelegramSourceConnection
+
+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 UserTelegramSourceConnection
+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/UserTelegramSourceConnectionRequest.md

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

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

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

@@ -0,0 +1,57 @@
+
+# UserWriteStage
+
+UserWriteStage Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | string
+`name` | string
+`component` | string
+`verboseName` | string
+`verboseNamePlural` | string
+`metaModelName` | string
+`flowSet` | [Array<FlowSet>](FlowSet.md)
+`userCreationMode` | [UserCreationModeEnum](UserCreationModeEnum.md)
+`createUsersAsInactive` | boolean
+`createUsersGroup` | string
+`userType` | [UserTypeEnum](UserTypeEnum.md)
+`userPathTemplate` | string
+
+## Example
+
+```typescript
+import type { UserWriteStage } 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,
+  "userCreationMode": null,
+  "createUsersAsInactive": null,
+  "createUsersGroup": null,
+  "userType": null,
+  "userPathTemplate": null,
+} satisfies UserWriteStage
+
+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 UserWriteStage
+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/UserWriteStageRequest.md

@@ -0,0 +1,45 @@
+
+# UserWriteStageRequest
+
+UserWriteStage Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`userCreationMode` | [UserCreationModeEnum](UserCreationModeEnum.md)
+`createUsersAsInactive` | boolean
+`createUsersGroup` | string
+`userType` | [UserTypeEnum](UserTypeEnum.md)
+`userPathTemplate` | string
+
+## Example
+
+```typescript
+import type { UserWriteStageRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "userCreationMode": null,
+  "createUsersAsInactive": null,
+  "createUsersGroup": null,
+  "userType": null,
+  "userPathTemplate": null,
+} satisfies UserWriteStageRequest
+
+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 UserWriteStageRequest
+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/ValidationError.md

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

@@ -0,0 +1,45 @@
+
+# Version
+
+Get running and latest version.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`versionCurrent` | string
+`versionLatest` | string
+`versionLatestValid` | boolean
+`buildHash` | string
+`outdated` | boolean
+`outpostOutdated` | boolean
+
+## Example
+
+```typescript
+import type { Version } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "versionCurrent": null,
+  "versionLatest": null,
+  "versionLatestValid": null,
+  "buildHash": null,
+  "outdated": null,
+  "outpostOutdated": null,
+} satisfies Version
+
+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 Version
+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/VersionHistory.md

@@ -0,0 +1,41 @@
+
+# VersionHistory
+
+VersionHistory Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`timestamp` | Date
+`version` | string
+`build` | string
+
+## Example
+
+```typescript
+import type { VersionHistory } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "timestamp": null,
+  "version": null,
+  "build": null,
+} satisfies VersionHistory
+
+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 VersionHistory
+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/WebAuthnDevice.md

@@ -0,0 +1,45 @@
+
+# WebAuthnDevice
+
+Serializer for WebAuthn authenticator devices
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | number
+`name` | string
+`createdOn` | Date
+`deviceType` | [WebAuthnDeviceType](WebAuthnDeviceType.md)
+`aaguid` | string
+`user` | [PartialUser](PartialUser.md)
+
+## Example
+
+```typescript
+import type { WebAuthnDevice } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+  "name": null,
+  "createdOn": null,
+  "deviceType": null,
+  "aaguid": null,
+  "user": null,
+} satisfies WebAuthnDevice
+
+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 WebAuthnDevice
+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/WebAuthnDeviceRequest.md

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

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