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

package/docs/PaginatedUserKerberosSourceConnectionList.md

@@ -0,0 +1,38 @@
+
+# PaginatedUserKerberosSourceConnectionList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pagination` | [Pagination](Pagination.md)
+`results` | [Array<UserKerberosSourceConnection>](UserKerberosSourceConnection.md)
+`autocomplete` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { PaginatedUserKerberosSourceConnectionList } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pagination": null,
+  "results": null,
+  "autocomplete": null,
+} satisfies PaginatedUserKerberosSourceConnectionList
+
+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 PaginatedUserKerberosSourceConnectionList
+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/PaginatedUserLDAPSourceConnectionList.md

@@ -0,0 +1,38 @@
+
+# PaginatedUserLDAPSourceConnectionList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pagination` | [Pagination](Pagination.md)
+`results` | [Array<UserLDAPSourceConnection>](UserLDAPSourceConnection.md)
+`autocomplete` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { PaginatedUserLDAPSourceConnectionList } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pagination": null,
+  "results": null,
+  "autocomplete": null,
+} satisfies PaginatedUserLDAPSourceConnectionList
+
+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 PaginatedUserLDAPSourceConnectionList
+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/PaginatedUserList.md

@@ -0,0 +1,38 @@
+
+# PaginatedUserList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pagination` | [Pagination](Pagination.md)
+`results` | [Array<User>](User.md)
+`autocomplete` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { PaginatedUserList } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pagination": null,
+  "results": null,
+  "autocomplete": null,
+} satisfies PaginatedUserList
+
+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 PaginatedUserList
+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/PaginatedUserLoginStageList.md

@@ -0,0 +1,38 @@
+
+# PaginatedUserLoginStageList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pagination` | [Pagination](Pagination.md)
+`results` | [Array<UserLoginStage>](UserLoginStage.md)
+`autocomplete` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { PaginatedUserLoginStageList } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pagination": null,
+  "results": null,
+  "autocomplete": null,
+} satisfies PaginatedUserLoginStageList
+
+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 PaginatedUserLoginStageList
+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/PaginatedUserLogoutStageList.md

@@ -0,0 +1,38 @@
+
+# PaginatedUserLogoutStageList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pagination` | [Pagination](Pagination.md)
+`results` | [Array<UserLogoutStage>](UserLogoutStage.md)
+`autocomplete` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { PaginatedUserLogoutStageList } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pagination": null,
+  "results": null,
+  "autocomplete": null,
+} satisfies PaginatedUserLogoutStageList
+
+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 PaginatedUserLogoutStageList
+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/PaginatedUserOAuthSourceConnectionList.md

@@ -0,0 +1,38 @@
+
+# PaginatedUserOAuthSourceConnectionList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pagination` | [Pagination](Pagination.md)
+`results` | [Array<UserOAuthSourceConnection>](UserOAuthSourceConnection.md)
+`autocomplete` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { PaginatedUserOAuthSourceConnectionList } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pagination": null,
+  "results": null,
+  "autocomplete": null,
+} satisfies PaginatedUserOAuthSourceConnectionList
+
+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 PaginatedUserOAuthSourceConnectionList
+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/PaginatedUserPlexSourceConnectionList.md

@@ -0,0 +1,38 @@
+
+# PaginatedUserPlexSourceConnectionList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pagination` | [Pagination](Pagination.md)
+`results` | [Array<UserPlexSourceConnection>](UserPlexSourceConnection.md)
+`autocomplete` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { PaginatedUserPlexSourceConnectionList } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pagination": null,
+  "results": null,
+  "autocomplete": null,
+} satisfies PaginatedUserPlexSourceConnectionList
+
+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 PaginatedUserPlexSourceConnectionList
+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/PaginatedUserSAMLSourceConnectionList.md

@@ -0,0 +1,38 @@
+
+# PaginatedUserSAMLSourceConnectionList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pagination` | [Pagination](Pagination.md)
+`results` | [Array<UserSAMLSourceConnection>](UserSAMLSourceConnection.md)
+`autocomplete` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { PaginatedUserSAMLSourceConnectionList } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pagination": null,
+  "results": null,
+  "autocomplete": null,
+} satisfies PaginatedUserSAMLSourceConnectionList
+
+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 PaginatedUserSAMLSourceConnectionList
+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/PaginatedUserSourceConnectionList.md

@@ -0,0 +1,38 @@
+
+# PaginatedUserSourceConnectionList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pagination` | [Pagination](Pagination.md)
+`results` | [Array<UserSourceConnection>](UserSourceConnection.md)
+`autocomplete` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { PaginatedUserSourceConnectionList } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pagination": null,
+  "results": null,
+  "autocomplete": null,
+} satisfies PaginatedUserSourceConnectionList
+
+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 PaginatedUserSourceConnectionList
+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/PaginatedUserTelegramSourceConnectionList.md

@@ -0,0 +1,38 @@
+
+# PaginatedUserTelegramSourceConnectionList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pagination` | [Pagination](Pagination.md)
+`results` | [Array<UserTelegramSourceConnection>](UserTelegramSourceConnection.md)
+`autocomplete` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { PaginatedUserTelegramSourceConnectionList } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pagination": null,
+  "results": null,
+  "autocomplete": null,
+} satisfies PaginatedUserTelegramSourceConnectionList
+
+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 PaginatedUserTelegramSourceConnectionList
+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/PaginatedUserWriteStageList.md

@@ -0,0 +1,38 @@
+
+# PaginatedUserWriteStageList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pagination` | [Pagination](Pagination.md)
+`results` | [Array<UserWriteStage>](UserWriteStage.md)
+`autocomplete` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { PaginatedUserWriteStageList } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pagination": null,
+  "results": null,
+  "autocomplete": null,
+} satisfies PaginatedUserWriteStageList
+
+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 PaginatedUserWriteStageList
+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/PaginatedWebAuthnDeviceList.md

@@ -0,0 +1,38 @@
+
+# PaginatedWebAuthnDeviceList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pagination` | [Pagination](Pagination.md)
+`results` | [Array<WebAuthnDevice>](WebAuthnDevice.md)
+`autocomplete` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { PaginatedWebAuthnDeviceList } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pagination": null,
+  "results": null,
+  "autocomplete": null,
+} satisfies PaginatedWebAuthnDeviceList
+
+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 PaginatedWebAuthnDeviceList
+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/PaginatedWebAuthnDeviceTypeList.md

@@ -0,0 +1,38 @@
+
+# PaginatedWebAuthnDeviceTypeList
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pagination` | [Pagination](Pagination.md)
+`results` | [Array<WebAuthnDeviceType>](WebAuthnDeviceType.md)
+`autocomplete` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { PaginatedWebAuthnDeviceTypeList } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pagination": null,
+  "results": null,
+  "autocomplete": null,
+} satisfies PaginatedWebAuthnDeviceTypeList
+
+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 PaginatedWebAuthnDeviceTypeList
+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/Pagination.md

@@ -0,0 +1,46 @@
+
+# Pagination
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`next` | number
+`previous` | number
+`count` | number
+`current` | number
+`totalPages` | number
+`startIndex` | number
+`endIndex` | number
+
+## Example
+
+```typescript
+import type { Pagination } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "next": null,
+  "previous": null,
+  "count": null,
+  "current": null,
+  "totalPages": null,
+  "startIndex": null,
+  "endIndex": null,
+} satisfies Pagination
+
+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 Pagination
+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/PartialGroup.md

@@ -0,0 +1,43 @@
+
+# PartialGroup
+
+Partial Group Serializer, does not include child relations.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | string
+`numPk` | number
+`name` | string
+`isSuperuser` | boolean
+`attributes` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { PartialGroup } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+  "numPk": null,
+  "name": null,
+  "isSuperuser": null,
+  "attributes": null,
+} satisfies PartialGroup
+
+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 PartialGroup
+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/PartialUser.md

@@ -0,0 +1,49 @@
+
+# PartialUser
+
+Partial User Serializer, does not include child relations.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | number
+`username` | string
+`name` | string
+`isActive` | boolean
+`lastLogin` | Date
+`email` | string
+`attributes` | { [key: string]: any; }
+`uid` | string
+
+## Example
+
+```typescript
+import type { PartialUser } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+  "username": null,
+  "name": null,
+  "isActive": null,
+  "lastLogin": null,
+  "email": null,
+  "attributes": null,
+  "uid": null,
+} satisfies PartialUser
+
+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 PartialUser
+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/PasswordChallenge.md

@@ -0,0 +1,47 @@
+
+# PasswordChallenge
+
+Password challenge UI fields
+
+## Properties
+
+Name | Type
+------------ | -------------
+`flowInfo` | [ContextualFlowInfo](ContextualFlowInfo.md)
+`component` | string
+`responseErrors` | { [key: string]: Array<ErrorDetail>; }
+`pendingUser` | string
+`pendingUserAvatar` | string
+`recoveryUrl` | string
+`allowShowPassword` | boolean
+
+## Example
+
+```typescript
+import type { PasswordChallenge } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "flowInfo": null,
+  "component": null,
+  "responseErrors": null,
+  "pendingUser": null,
+  "pendingUserAvatar": null,
+  "recoveryUrl": null,
+  "allowShowPassword": null,
+} satisfies PasswordChallenge
+
+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 PasswordChallenge
+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)
+
+