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

package/docs/GoogleWorkspaceProviderRequest.md

@@ -0,0 +1,61 @@
+
+# GoogleWorkspaceProviderRequest
+
+GoogleWorkspaceProvider Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`propertyMappings` | Array<string>
+`propertyMappingsGroup` | Array<string>
+`delegatedSubject` | string
+`credentials` | { [key: string]: any; }
+`scopes` | string
+`excludeUsersServiceAccount` | boolean
+`filterGroup` | string
+`userDeleteAction` | [OutgoingSyncDeleteAction](OutgoingSyncDeleteAction.md)
+`groupDeleteAction` | [OutgoingSyncDeleteAction](OutgoingSyncDeleteAction.md)
+`defaultGroupEmailDomain` | string
+`syncPageSize` | number
+`syncPageTimeout` | string
+`dryRun` | boolean
+
+## Example
+
+```typescript
+import type { GoogleWorkspaceProviderRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "propertyMappings": null,
+  "propertyMappingsGroup": null,
+  "delegatedSubject": null,
+  "credentials": null,
+  "scopes": null,
+  "excludeUsersServiceAccount": null,
+  "filterGroup": null,
+  "userDeleteAction": null,
+  "groupDeleteAction": null,
+  "defaultGroupEmailDomain": null,
+  "syncPageSize": null,
+  "syncPageTimeout": null,
+  "dryRun": null,
+} satisfies GoogleWorkspaceProviderRequest
+
+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 GoogleWorkspaceProviderRequest
+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/GoogleWorkspaceProviderUser.md

@@ -0,0 +1,45 @@
+
+# GoogleWorkspaceProviderUser
+
+GoogleWorkspaceProviderUser Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`googleId` | string
+`user` | number
+`userObj` | [PartialUser](PartialUser.md)
+`provider` | number
+`attributes` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { GoogleWorkspaceProviderUser } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "googleId": null,
+  "user": null,
+  "userObj": null,
+  "provider": null,
+  "attributes": null,
+} satisfies GoogleWorkspaceProviderUser
+
+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 GoogleWorkspaceProviderUser
+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/GoogleWorkspaceProviderUserRequest.md

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

@@ -0,0 +1,59 @@
+
+# Group
+
+Group Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | string
+`numPk` | number
+`name` | string
+`isSuperuser` | boolean
+`parents` | Array<string>
+`parentsObj` | [Array<RelatedGroup>](RelatedGroup.md)
+`users` | Array<number>
+`usersObj` | [Array<PartialUser>](PartialUser.md)
+`attributes` | { [key: string]: any; }
+`roles` | Array<string>
+`rolesObj` | [Array<Role>](Role.md)
+`children` | Array<string>
+`childrenObj` | [Array<RelatedGroup>](RelatedGroup.md)
+
+## Example
+
+```typescript
+import type { Group } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+  "numPk": null,
+  "name": null,
+  "isSuperuser": null,
+  "parents": null,
+  "parentsObj": null,
+  "users": null,
+  "usersObj": null,
+  "attributes": null,
+  "roles": null,
+  "rolesObj": null,
+  "children": null,
+  "childrenObj": null,
+} satisfies Group
+
+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 Group
+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/GroupKerberosSourceConnection.md

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,45 @@
+
+# GroupRequest
+
+Group Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`isSuperuser` | boolean
+`parents` | Array<string>
+`users` | Array<number>
+`attributes` | { [key: string]: any; }
+`roles` | Array<string>
+
+## Example
+
+```typescript
+import type { GroupRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "isSuperuser": null,
+  "parents": null,
+  "users": null,
+  "attributes": null,
+  "roles": null,
+} satisfies GroupRequest
+
+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 GroupRequest
+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/GroupSAMLSourceConnection.md

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