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

package/docs/LDAPSourcePropertyMappingRequest.md

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

@@ -0,0 +1,103 @@
+
+# LDAPSourceRequest
+
+LDAP Source Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`slug` | string
+`enabled` | boolean
+`promoted` | boolean
+`authenticationFlow` | string
+`enrollmentFlow` | string
+`userPropertyMappings` | Array<string>
+`groupPropertyMappings` | Array<string>
+`policyEngineMode` | [PolicyEngineMode](PolicyEngineMode.md)
+`userMatchingMode` | [UserMatchingModeEnum](UserMatchingModeEnum.md)
+`userPathTemplate` | string
+`icon` | string
+`serverUri` | string
+`peerCertificate` | string
+`clientCertificate` | string
+`bindCn` | string
+`bindPassword` | string
+`startTls` | boolean
+`sni` | boolean
+`baseDn` | string
+`additionalUserDn` | string
+`additionalGroupDn` | string
+`userObjectFilter` | string
+`groupObjectFilter` | string
+`groupMembershipField` | string
+`userMembershipAttribute` | string
+`objectUniquenessField` | string
+`passwordLoginUpdateInternalPassword` | boolean
+`syncUsers` | boolean
+`syncUsersPassword` | boolean
+`syncGroups` | boolean
+`syncParentGroup` | string
+`lookupGroupsFromUser` | boolean
+`deleteNotFoundObjects` | boolean
+`syncOutgoingTriggerMode` | [SyncOutgoingTriggerModeEnum](SyncOutgoingTriggerModeEnum.md)
+
+## Example
+
+```typescript
+import type { LDAPSourceRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "slug": null,
+  "enabled": null,
+  "promoted": null,
+  "authenticationFlow": null,
+  "enrollmentFlow": null,
+  "userPropertyMappings": null,
+  "groupPropertyMappings": null,
+  "policyEngineMode": null,
+  "userMatchingMode": null,
+  "userPathTemplate": null,
+  "icon": null,
+  "serverUri": null,
+  "peerCertificate": null,
+  "clientCertificate": null,
+  "bindCn": null,
+  "bindPassword": null,
+  "startTls": null,
+  "sni": null,
+  "baseDn": null,
+  "additionalUserDn": null,
+  "additionalGroupDn": null,
+  "userObjectFilter": null,
+  "groupObjectFilter": null,
+  "groupMembershipField": null,
+  "userMembershipAttribute": null,
+  "objectUniquenessField": null,
+  "passwordLoginUpdateInternalPassword": null,
+  "syncUsers": null,
+  "syncUsersPassword": null,
+  "syncGroups": null,
+  "syncParentGroup": null,
+  "lookupGroupsFromUser": null,
+  "deleteNotFoundObjects": null,
+  "syncOutgoingTriggerMode": null,
+} satisfies LDAPSourceRequest
+
+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 LDAPSourceRequest
+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/LastTaskStatusEnum.md

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

@@ -0,0 +1,45 @@
+
+# License
+
+License Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`licenseUuid` | string
+`name` | string
+`key` | string
+`expiry` | Date
+`internalUsers` | number
+`externalUsers` | number
+
+## Example
+
+```typescript
+import type { License } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "licenseUuid": null,
+  "name": null,
+  "key": null,
+  "expiry": null,
+  "internalUsers": null,
+  "externalUsers": null,
+} satisfies License
+
+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 License
+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/LicenseFlagsEnum.md

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

@@ -0,0 +1,41 @@
+
+# LicenseForecast
+
+Serializer for license forecast
+
+## Properties
+
+Name | Type
+------------ | -------------
+`internalUsers` | number
+`externalUsers` | number
+`forecastedInternalUsers` | number
+`forecastedExternalUsers` | number
+
+## Example
+
+```typescript
+import type { LicenseForecast } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "internalUsers": null,
+  "externalUsers": null,
+  "forecastedInternalUsers": null,
+  "forecastedExternalUsers": null,
+} satisfies LicenseForecast
+
+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 LicenseForecast
+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/LicenseRequest.md

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

@@ -0,0 +1,43 @@
+
+# LicenseSummary
+
+Serializer for license status
+
+## Properties
+
+Name | Type
+------------ | -------------
+`internalUsers` | number
+`externalUsers` | number
+`status` | [LicenseSummaryStatusEnum](LicenseSummaryStatusEnum.md)
+`latestValid` | Date
+`licenseFlags` | [Array<LicenseFlagsEnum>](LicenseFlagsEnum.md)
+
+## Example
+
+```typescript
+import type { LicenseSummary } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "internalUsers": null,
+  "externalUsers": null,
+  "status": null,
+  "latestValid": null,
+  "licenseFlags": null,
+} satisfies LicenseSummary
+
+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 LicenseSummary
+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/LicenseSummaryStatusEnum.md

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

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

@@ -0,0 +1,43 @@
+
+# LogEvent
+
+Single log message with all context logged.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`timestamp` | Date
+`logLevel` | [LogLevelEnum](LogLevelEnum.md)
+`logger` | string
+`event` | string
+`attributes` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { LogEvent } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "timestamp": null,
+  "logLevel": null,
+  "logger": null,
+  "event": null,
+  "attributes": null,
+} satisfies LogEvent
+
+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 LogEvent
+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/LogLevelEnum.md

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

@@ -0,0 +1,54 @@
+
+# LoginChallengeTypes
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`flowInfo` | [ContextualFlowInfo](ContextualFlowInfo.md)
+`component` | string
+`responseErrors` | { [key: string]: Array<ErrorDetail>; }
+`to` | string
+`clientId` | string
+`scope` | string
+`redirectUri` | string
+`state` | string
+`slug` | string
+`botUsername` | string
+`requestMessageAccess` | boolean
+
+## Example
+
+```typescript
+import type { LoginChallengeTypes } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "flowInfo": null,
+  "component": null,
+  "responseErrors": null,
+  "to": null,
+  "clientId": null,
+  "scope": null,
+  "redirectUri": null,
+  "state": null,
+  "slug": null,
+  "botUsername": null,
+  "requestMessageAccess": null,
+} satisfies LoginChallengeTypes
+
+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 LoginChallengeTypes
+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/LoginSource.md

@@ -0,0 +1,41 @@
+
+# LoginSource
+
+Serializer for Login buttons of sources
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`iconUrl` | string
+`promoted` | boolean
+`challenge` | [LoginChallengeTypes](LoginChallengeTypes.md)
+
+## Example
+
+```typescript
+import type { LoginSource } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "iconUrl": null,
+  "promoted": null,
+  "challenge": null,
+} satisfies LoginSource
+
+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 LoginSource
+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/MDMConfigRequest.md

@@ -0,0 +1,37 @@
+
+# MDMConfigRequest
+
+Base serializer class which doesn\'t implement create/update methods
+
+## Properties
+
+Name | Type
+------------ | -------------
+`platform` | [DeviceFactsOSFamily](DeviceFactsOSFamily.md)
+`enrollmentToken` | string
+
+## Example
+
+```typescript
+import type { MDMConfigRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "platform": null,
+  "enrollmentToken": null,
+} satisfies MDMConfigRequest
+
+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 MDMConfigRequest
+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/MDMConfigResponse.md

@@ -0,0 +1,39 @@
+
+# MDMConfigResponse
+
+Base serializer class which doesn\'t implement create/update methods
+
+## Properties
+
+Name | Type
+------------ | -------------
+`config` | string
+`mimeType` | string
+`filename` | string
+
+## Example
+
+```typescript
+import type { MDMConfigResponse } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "config": null,
+  "mimeType": null,
+  "filename": null,
+} satisfies MDMConfigResponse
+
+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 MDMConfigResponse
+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)
+
+