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

package/docs/UserAccountRequest.md

@@ -0,0 +1,35 @@
+
+# UserAccountRequest
+
+Account adding/removing operations
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | number
+
+## Example
+
+```typescript
+import type { UserAccountRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+} satisfies UserAccountRequest
+
+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 UserAccountRequest
+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/UserAccountSerializerForRoleRequest.md

@@ -0,0 +1,35 @@
+
+# UserAccountSerializerForRoleRequest
+
+Account adding/removing operations
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | number
+
+## Example
+
+```typescript
+import type { UserAccountSerializerForRoleRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+} satisfies UserAccountSerializerForRoleRequest
+
+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 UserAccountSerializerForRoleRequest
+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/UserAttributeEnum.md

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

@@ -0,0 +1,45 @@
+
+# UserConsent
+
+UserConsent Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | number
+`expires` | Date
+`expiring` | boolean
+`user` | [User](User.md)
+`application` | [Application](Application.md)
+`permissions` | string
+
+## Example
+
+```typescript
+import type { UserConsent } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+  "expires": null,
+  "expiring": null,
+  "user": null,
+  "application": null,
+  "permissions": null,
+} satisfies UserConsent
+
+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 UserConsent
+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/UserCreationModeEnum.md

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

@@ -0,0 +1,47 @@
+
+# UserDeleteStage
+
+UserDeleteStage Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | string
+`name` | string
+`component` | string
+`verboseName` | string
+`verboseNamePlural` | string
+`metaModelName` | string
+`flowSet` | [Array<FlowSet>](FlowSet.md)
+
+## Example
+
+```typescript
+import type { UserDeleteStage } 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,
+} satisfies UserDeleteStage
+
+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 UserDeleteStage
+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/UserDeleteStageRequest.md

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

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

@@ -0,0 +1,47 @@
+
+# UserKerberosSourceConnection
+
+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 { UserKerberosSourceConnection } 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 UserKerberosSourceConnection
+
+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 UserKerberosSourceConnection
+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/UserKerberosSourceConnectionRequest.md

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

@@ -0,0 +1,47 @@
+
+# UserLDAPSourceConnection
+
+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 { UserLDAPSourceConnection } 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 UserLDAPSourceConnection
+
+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 UserLDAPSourceConnection
+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/UserLDAPSourceConnectionRequest.md

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

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

@@ -0,0 +1,37 @@
+
+# UserLoginChallengeResponseRequest
+
+User login challenge
+
+## Properties
+
+Name | Type
+------------ | -------------
+`component` | string
+`rememberMe` | boolean
+
+## Example
+
+```typescript
+import type { UserLoginChallengeResponseRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "component": null,
+  "rememberMe": null,
+} satisfies UserLoginChallengeResponseRequest
+
+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 UserLoginChallengeResponseRequest
+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/UserLoginStage.md

@@ -0,0 +1,59 @@
+
+# UserLoginStage
+
+UserLoginStage Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | string
+`name` | string
+`component` | string
+`verboseName` | string
+`verboseNamePlural` | string
+`metaModelName` | string
+`flowSet` | [Array<FlowSet>](FlowSet.md)
+`sessionDuration` | string
+`terminateOtherSessions` | boolean
+`rememberMeOffset` | string
+`networkBinding` | [NetworkBindingEnum](NetworkBindingEnum.md)
+`geoipBinding` | [GeoipBindingEnum](GeoipBindingEnum.md)
+`rememberDevice` | string
+
+## Example
+
+```typescript
+import type { UserLoginStage } 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,
+  "sessionDuration": null,
+  "terminateOtherSessions": null,
+  "rememberMeOffset": null,
+  "networkBinding": null,
+  "geoipBinding": null,
+  "rememberDevice": null,
+} satisfies UserLoginStage
+
+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 UserLoginStage
+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/UserLoginStageRequest.md

@@ -0,0 +1,47 @@
+
+# UserLoginStageRequest
+
+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 { UserLoginStageRequest } 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 UserLoginStageRequest
+
+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 UserLoginStageRequest
+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)
+
+