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

package/docs/UserLogoutStage.md

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

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

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

@@ -0,0 +1,49 @@
+
+# UserOAuthSourceConnection
+
+User source connection
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | number
+`user` | number
+`source` | string
+`sourceObj` | [Source](Source.md)
+`identifier` | string
+`created` | Date
+`lastUpdated` | Date
+`expires` | Date
+
+## Example
+
+```typescript
+import type { UserOAuthSourceConnection } 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,
+  "expires": null,
+} satisfies UserOAuthSourceConnection
+
+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 UserOAuthSourceConnection
+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/UserOAuthSourceConnectionRequest.md

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

@@ -0,0 +1,35 @@
+
+# UserPasswordSetRequest
+
+Payload to set a users\' password directly
+
+## Properties
+
+Name | Type
+------------ | -------------
+`password` | string
+
+## Example
+
+```typescript
+import type { UserPasswordSetRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "password": null,
+} satisfies UserPasswordSetRequest
+
+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 UserPasswordSetRequest
+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/UserPath.md

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

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

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

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

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

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

@@ -0,0 +1,59 @@
+
+# UserSelf
+
+User Serializer for information a user can retrieve about themselves
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | number
+`username` | string
+`name` | string
+`isActive` | boolean
+`isSuperuser` | boolean
+`groups` | [Array<UserSelfGroups>](UserSelfGroups.md)
+`roles` | [Array<UserSelfRoles>](UserSelfRoles.md)
+`email` | string
+`avatar` | string
+`uid` | string
+`settings` | { [key: string]: any; }
+`type` | [UserTypeEnum](UserTypeEnum.md)
+`systemPermissions` | Array<string>
+
+## Example
+
+```typescript
+import type { UserSelf } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+  "username": null,
+  "name": null,
+  "isActive": null,
+  "isSuperuser": null,
+  "groups": null,
+  "roles": null,
+  "email": null,
+  "avatar": null,
+  "uid": null,
+  "settings": null,
+  "type": null,
+  "systemPermissions": null,
+} satisfies UserSelf
+
+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 UserSelf
+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/UserSelfGroups.md

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

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

@@ -0,0 +1,41 @@
+
+# UserServiceAccountRequest
+
+Payload to create a service account
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`createGroup` | boolean
+`expiring` | boolean
+`expires` | Date
+
+## Example
+
+```typescript
+import type { UserServiceAccountRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "createGroup": null,
+  "expiring": null,
+  "expires": null,
+} satisfies UserServiceAccountRequest
+
+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 UserServiceAccountRequest
+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)
+
+