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

package/docs/CaptchaStage.md

@@ -0,0 +1,61 @@
+
+# CaptchaStage
+
+CaptchaStage Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | string
+`name` | string
+`component` | string
+`verboseName` | string
+`verboseNamePlural` | string
+`metaModelName` | string
+`flowSet` | [Array<FlowSet>](FlowSet.md)
+`publicKey` | string
+`jsUrl` | string
+`apiUrl` | string
+`interactive` | boolean
+`scoreMinThreshold` | number
+`scoreMaxThreshold` | number
+`errorOnInvalidScore` | boolean
+
+## Example
+
+```typescript
+import type { CaptchaStage } 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,
+  "publicKey": null,
+  "jsUrl": null,
+  "apiUrl": null,
+  "interactive": null,
+  "scoreMinThreshold": null,
+  "scoreMaxThreshold": null,
+  "errorOnInvalidScore": null,
+} satisfies CaptchaStage
+
+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 CaptchaStage
+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/CaptchaStageRequest.md

@@ -0,0 +1,51 @@
+
+# CaptchaStageRequest
+
+CaptchaStage Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`publicKey` | string
+`privateKey` | string
+`jsUrl` | string
+`apiUrl` | string
+`interactive` | boolean
+`scoreMinThreshold` | number
+`scoreMaxThreshold` | number
+`errorOnInvalidScore` | boolean
+
+## Example
+
+```typescript
+import type { CaptchaStageRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "publicKey": null,
+  "privateKey": null,
+  "jsUrl": null,
+  "apiUrl": null,
+  "interactive": null,
+  "scoreMinThreshold": null,
+  "scoreMaxThreshold": null,
+  "errorOnInvalidScore": null,
+} satisfies CaptchaStageRequest
+
+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 CaptchaStageRequest
+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/CertAttributeEnum.md

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

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

@@ -0,0 +1,41 @@
+
+# CertificateGenerationRequest
+
+Certificate generation parameters
+
+## Properties
+
+Name | Type
+------------ | -------------
+`commonName` | string
+`subjectAltName` | string
+`validityDays` | number
+`alg` | [AlgEnum](AlgEnum.md)
+
+## Example
+
+```typescript
+import type { CertificateGenerationRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "commonName": null,
+  "subjectAltName": null,
+  "validityDays": null,
+  "alg": null,
+} satisfies CertificateGenerationRequest
+
+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 CertificateGenerationRequest
+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/CertificateKeyPair.md

@@ -0,0 +1,55 @@
+
+# CertificateKeyPair
+
+CertificateKeyPair Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | string
+`name` | string
+`fingerprintSha256` | string
+`fingerprintSha1` | string
+`certExpiry` | Date
+`certSubject` | string
+`privateKeyAvailable` | boolean
+`keyType` | [KeyTypeEnum](KeyTypeEnum.md)
+`certificateDownloadUrl` | string
+`privateKeyDownloadUrl` | string
+`managed` | string
+
+## Example
+
+```typescript
+import type { CertificateKeyPair } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+  "name": null,
+  "fingerprintSha256": null,
+  "fingerprintSha1": null,
+  "certExpiry": null,
+  "certSubject": null,
+  "privateKeyAvailable": null,
+  "keyType": null,
+  "certificateDownloadUrl": null,
+  "privateKeyDownloadUrl": null,
+  "managed": null,
+} satisfies CertificateKeyPair
+
+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 CertificateKeyPair
+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/CertificateKeyPairRequest.md

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

@@ -0,0 +1,174 @@
+
+# ChallengeTypes
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`flowInfo` | [ContextualFlowInfo](ContextualFlowInfo.md)
+`component` | string
+`responseErrors` | { [key: string]: Array<ErrorDetail>; }
+`pendingUser` | string
+`pendingUserAvatar` | string
+`errorMessage` | string
+`clientId` | string
+`scope` | string
+`redirectUri` | string
+`state` | string
+`activationBarcode` | string
+`activationCode` | string
+`stageUuid` | string
+`email` | string
+`emailRequired` | boolean
+`phoneNumberRequired` | boolean
+`codes` | Array<string>
+`configUrl` | string
+`deviceChallenges` | [Array<DeviceChallenge>](DeviceChallenge.md)
+`configurationStages` | [Array<SelectableStage>](SelectableStage.md)
+`registration` | { [key: string]: object; }
+`url` | string
+`attrs` | { [key: string]: string; }
+`title` | string
+`siteKey` | string
+`jsUrl` | string
+`interactive` | boolean
+`headerText` | string
+`permissions` | [Array<ConsentPermission>](ConsentPermission.md)
+`additionalPermissions` | [Array<ConsentPermission>](ConsentPermission.md)
+`token` | string
+`name` | string
+`challenge` | string
+`challengeIdleTimeout` | number
+`requestId` | string
+`error` | string
+`traceback` | string
+`loadingOverlay` | boolean
+`loadingText` | string
+`userFields` | Array<string>
+`passwordFields` | boolean
+`allowShowPassword` | boolean
+`applicationPre` | string
+`flowDesignation` | [FlowDesignationEnum](FlowDesignationEnum.md)
+`captchaStage` | [CaptchaChallenge](CaptchaChallenge.md)
+`enrollUrl` | string
+`recoveryUrl` | string
+`passwordlessUrl` | string
+`primaryAction` | string
+`sources` | [Array<LoginSource>](LoginSource.md)
+`showSourceLabels` | boolean
+`enableRememberMe` | boolean
+`passkeyChallenge` | { [key: string]: object; }
+`logoutUrls` | Array<{ [key: string]: object; }>
+`postUrl` | string
+`samlRequest` | string
+`relayState` | string
+`providerName` | string
+`binding` | string
+`redirectUrl` | string
+`isComplete` | boolean
+`slug` | string
+`fields` | [Array<StagePrompt>](StagePrompt.md)
+`to` | string
+`applicationName` | string
+`applicationLaunchUrl` | string
+`invalidationFlowUrl` | string
+`brandName` | string
+`body` | string
+`botUsername` | string
+`requestMessageAccess` | boolean
+
+## Example
+
+```typescript
+import type { ChallengeTypes } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "flowInfo": null,
+  "component": null,
+  "responseErrors": null,
+  "pendingUser": null,
+  "pendingUserAvatar": null,
+  "errorMessage": null,
+  "clientId": null,
+  "scope": null,
+  "redirectUri": null,
+  "state": null,
+  "activationBarcode": null,
+  "activationCode": null,
+  "stageUuid": null,
+  "email": null,
+  "emailRequired": null,
+  "phoneNumberRequired": null,
+  "codes": null,
+  "configUrl": null,
+  "deviceChallenges": null,
+  "configurationStages": null,
+  "registration": null,
+  "url": null,
+  "attrs": null,
+  "title": null,
+  "siteKey": null,
+  "jsUrl": null,
+  "interactive": null,
+  "headerText": null,
+  "permissions": null,
+  "additionalPermissions": null,
+  "token": null,
+  "name": null,
+  "challenge": null,
+  "challengeIdleTimeout": null,
+  "requestId": null,
+  "error": null,
+  "traceback": null,
+  "loadingOverlay": null,
+  "loadingText": null,
+  "userFields": null,
+  "passwordFields": null,
+  "allowShowPassword": null,
+  "applicationPre": null,
+  "flowDesignation": null,
+  "captchaStage": null,
+  "enrollUrl": null,
+  "recoveryUrl": null,
+  "passwordlessUrl": null,
+  "primaryAction": null,
+  "sources": null,
+  "showSourceLabels": null,
+  "enableRememberMe": null,
+  "passkeyChallenge": null,
+  "logoutUrls": null,
+  "postUrl": null,
+  "samlRequest": null,
+  "relayState": null,
+  "providerName": null,
+  "binding": null,
+  "redirectUrl": null,
+  "isComplete": null,
+  "slug": null,
+  "fields": null,
+  "to": null,
+  "applicationName": null,
+  "applicationLaunchUrl": null,
+  "invalidationFlowUrl": null,
+  "brandName": null,
+  "body": null,
+  "botUsername": null,
+  "requestMessageAccess": null,
+} satisfies ChallengeTypes
+
+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 ChallengeTypes
+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/ClientTypeEnum.md

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

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

@@ -0,0 +1,43 @@
+
+# Config
+
+Serialize authentik Config into DRF Object
+
+## Properties
+
+Name | Type
+------------ | -------------
+`errorReporting` | [ErrorReportingConfig](ErrorReportingConfig.md)
+`capabilities` | [Array<CapabilitiesEnum>](CapabilitiesEnum.md)
+`cacheTimeout` | number
+`cacheTimeoutFlows` | number
+`cacheTimeoutPolicies` | number
+
+## Example
+
+```typescript
+import type { Config } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "errorReporting": null,
+  "capabilities": null,
+  "cacheTimeout": null,
+  "cacheTimeoutFlows": null,
+  "cacheTimeoutPolicies": null,
+} satisfies Config
+
+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 Config
+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/ConnectionToken.md

@@ -0,0 +1,45 @@
+
+# ConnectionToken
+
+ConnectionToken Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | string
+`provider` | number
+`providerObj` | [RACProvider](RACProvider.md)
+`endpoint` | string
+`endpointObj` | [Endpoint](Endpoint.md)
+`user` | [PartialUser](PartialUser.md)
+
+## Example
+
+```typescript
+import type { ConnectionToken } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+  "provider": null,
+  "providerObj": null,
+  "endpoint": null,
+  "endpointObj": null,
+  "user": null,
+} satisfies ConnectionToken
+
+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 ConnectionToken
+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/ConnectionTokenRequest.md

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