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

package/docs/SCIMProviderRequest.md

@@ -0,0 +1,65 @@
+
+# SCIMProviderRequest
+
+SCIMProvider Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`propertyMappings` | Array<string>
+`propertyMappingsGroup` | Array<string>
+`url` | string
+`verifyCertificates` | boolean
+`token` | string
+`authMode` | [SCIMAuthenticationModeEnum](SCIMAuthenticationModeEnum.md)
+`authOauth` | string
+`authOauthParams` | { [key: string]: any; }
+`compatibilityMode` | [CompatibilityModeEnum](CompatibilityModeEnum.md)
+`serviceProviderConfigCacheTimeout` | string
+`excludeUsersServiceAccount` | boolean
+`filterGroup` | string
+`syncPageSize` | number
+`syncPageTimeout` | string
+`dryRun` | boolean
+
+## Example
+
+```typescript
+import type { SCIMProviderRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "propertyMappings": null,
+  "propertyMappingsGroup": null,
+  "url": null,
+  "verifyCertificates": null,
+  "token": null,
+  "authMode": null,
+  "authOauth": null,
+  "authOauthParams": null,
+  "compatibilityMode": null,
+  "serviceProviderConfigCacheTimeout": null,
+  "excludeUsersServiceAccount": null,
+  "filterGroup": null,
+  "syncPageSize": null,
+  "syncPageTimeout": null,
+  "dryRun": null,
+} satisfies SCIMProviderRequest
+
+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 SCIMProviderRequest
+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/SCIMProviderUser.md

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

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

@@ -0,0 +1,61 @@
+
+# SCIMSource
+
+SCIMSource Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | string
+`name` | string
+`slug` | string
+`enabled` | boolean
+`userPropertyMappings` | Array<string>
+`groupPropertyMappings` | Array<string>
+`component` | string
+`verboseName` | string
+`verboseNamePlural` | string
+`metaModelName` | string
+`managed` | string
+`userPathTemplate` | string
+`rootUrl` | string
+`tokenObj` | [Token](Token.md)
+
+## Example
+
+```typescript
+import type { SCIMSource } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+  "name": null,
+  "slug": null,
+  "enabled": null,
+  "userPropertyMappings": null,
+  "groupPropertyMappings": null,
+  "component": null,
+  "verboseName": null,
+  "verboseNamePlural": null,
+  "metaModelName": null,
+  "managed": null,
+  "userPathTemplate": null,
+  "rootUrl": null,
+  "tokenObj": null,
+} satisfies SCIMSource
+
+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 SCIMSource
+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/SCIMSourceGroup.md

@@ -0,0 +1,45 @@
+
+# SCIMSourceGroup
+
+SCIMSourceGroup Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`externalId` | string
+`group` | string
+`groupObj` | [PartialGroup](PartialGroup.md)
+`source` | string
+`attributes` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { SCIMSourceGroup } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "externalId": null,
+  "group": null,
+  "groupObj": null,
+  "source": null,
+  "attributes": null,
+} satisfies SCIMSourceGroup
+
+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 SCIMSourceGroup
+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/SCIMSourceGroupRequest.md

@@ -0,0 +1,43 @@
+
+# SCIMSourceGroupRequest
+
+SCIMSourceGroup Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`externalId` | string
+`group` | string
+`source` | string
+`attributes` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { SCIMSourceGroupRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "externalId": null,
+  "group": null,
+  "source": null,
+  "attributes": null,
+} satisfies SCIMSourceGroupRequest
+
+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 SCIMSourceGroupRequest
+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/SCIMSourcePropertyMapping.md

@@ -0,0 +1,49 @@
+
+# SCIMSourcePropertyMapping
+
+SCIMSourcePropertyMapping Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | string
+`managed` | string
+`name` | string
+`expression` | string
+`component` | string
+`verboseName` | string
+`verboseNamePlural` | string
+`metaModelName` | string
+
+## Example
+
+```typescript
+import type { SCIMSourcePropertyMapping } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+  "managed": null,
+  "name": null,
+  "expression": null,
+  "component": null,
+  "verboseName": null,
+  "verboseNamePlural": null,
+  "metaModelName": null,
+} satisfies SCIMSourcePropertyMapping
+
+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 SCIMSourcePropertyMapping
+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/SCIMSourcePropertyMappingRequest.md

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

@@ -0,0 +1,45 @@
+
+# SCIMSourceRequest
+
+SCIMSource Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`slug` | string
+`enabled` | boolean
+`userPropertyMappings` | Array<string>
+`groupPropertyMappings` | Array<string>
+`userPathTemplate` | string
+
+## Example
+
+```typescript
+import type { SCIMSourceRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "slug": null,
+  "enabled": null,
+  "userPropertyMappings": null,
+  "groupPropertyMappings": null,
+  "userPathTemplate": null,
+} satisfies SCIMSourceRequest
+
+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 SCIMSourceRequest
+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/SCIMSourceUser.md

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

@@ -0,0 +1,43 @@
+
+# SCIMSourceUserRequest
+
+SCIMSourceUser Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`externalId` | string
+`user` | number
+`source` | string
+`attributes` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { SCIMSourceUserRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "externalId": null,
+  "user": null,
+  "source": null,
+  "attributes": null,
+} satisfies SCIMSourceUserRequest
+
+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 SCIMSourceUserRequest
+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/SMSDevice.md

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

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

@@ -0,0 +1,55 @@
+
+# SSFProvider
+
+SSFProvider Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | number
+`name` | string
+`component` | string
+`verboseName` | string
+`verboseNamePlural` | string
+`metaModelName` | string
+`signingKey` | string
+`tokenObj` | [Token](Token.md)
+`oidcAuthProviders` | Array<number>
+`ssfUrl` | string
+`eventRetention` | string
+
+## Example
+
+```typescript
+import type { SSFProvider } 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,
+  "signingKey": null,
+  "tokenObj": null,
+  "oidcAuthProviders": null,
+  "ssfUrl": null,
+  "eventRetention": null,
+} satisfies SSFProvider
+
+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 SSFProvider
+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/SSFProviderRequest.md

@@ -0,0 +1,41 @@
+
+# SSFProviderRequest
+
+SSFProvider Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`signingKey` | string
+`oidcAuthProviders` | Array<number>
+`eventRetention` | string
+
+## Example
+
+```typescript
+import type { SSFProviderRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "signingKey": null,
+  "oidcAuthProviders": null,
+  "eventRetention": null,
+} satisfies SSFProviderRequest
+
+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 SSFProviderRequest
+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)
+
+