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

package/docs/AgentAuthenticationResponse.md

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

@@ -0,0 +1,51 @@
+
+# AgentConfig
+
+Base serializer class which doesn\'t implement create/update methods
+
+## Properties
+
+Name | Type
+------------ | -------------
+`deviceId` | string
+`refreshInterval` | number
+`authorizationFlow` | string
+`jwksAuth` | { [key: string]: any; }
+`jwksChallenge` | { [key: string]: any; }
+`nssUidOffset` | number
+`nssGidOffset` | number
+`authTerminateSessionOnExpiry` | boolean
+`systemConfig` | [Config](Config.md)
+
+## Example
+
+```typescript
+import type { AgentConfig } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "deviceId": null,
+  "refreshInterval": null,
+  "authorizationFlow": null,
+  "jwksAuth": null,
+  "jwksChallenge": null,
+  "nssUidOffset": null,
+  "nssGidOffset": null,
+  "authTerminateSessionOnExpiry": null,
+  "systemConfig": null,
+} satisfies AgentConfig
+
+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 AgentConfig
+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/AgentConnector.md

@@ -0,0 +1,68 @@
+
+# AgentConnector
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`connectorUuid` | string
+`name` | string
+`enabled` | boolean
+`component` | string
+`verboseName` | string
+`verboseNamePlural` | string
+`metaModelName` | string
+`snapshotExpiry` | string
+`authSessionDuration` | string
+`authTerminateSessionOnExpiry` | boolean
+`refreshInterval` | string
+`authorizationFlow` | string
+`nssUidOffset` | number
+`nssGidOffset` | number
+`challengeKey` | string
+`challengeIdleTimeout` | string
+`challengeTriggerCheckIn` | boolean
+`jwtFederationProviders` | Array<number>
+
+## Example
+
+```typescript
+import type { AgentConnector } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "connectorUuid": null,
+  "name": null,
+  "enabled": null,
+  "component": null,
+  "verboseName": null,
+  "verboseNamePlural": null,
+  "metaModelName": null,
+  "snapshotExpiry": null,
+  "authSessionDuration": null,
+  "authTerminateSessionOnExpiry": null,
+  "refreshInterval": null,
+  "authorizationFlow": null,
+  "nssUidOffset": null,
+  "nssGidOffset": null,
+  "challengeKey": null,
+  "challengeIdleTimeout": null,
+  "challengeTriggerCheckIn": null,
+  "jwtFederationProviders": null,
+} satisfies AgentConnector
+
+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 AgentConnector
+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/AgentConnectorRequest.md

@@ -0,0 +1,60 @@
+
+# AgentConnectorRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`connectorUuid` | string
+`name` | string
+`enabled` | boolean
+`snapshotExpiry` | string
+`authSessionDuration` | string
+`authTerminateSessionOnExpiry` | boolean
+`refreshInterval` | string
+`authorizationFlow` | string
+`nssUidOffset` | number
+`nssGidOffset` | number
+`challengeKey` | string
+`challengeIdleTimeout` | string
+`challengeTriggerCheckIn` | boolean
+`jwtFederationProviders` | Array<number>
+
+## Example
+
+```typescript
+import type { AgentConnectorRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "connectorUuid": null,
+  "name": null,
+  "enabled": null,
+  "snapshotExpiry": null,
+  "authSessionDuration": null,
+  "authTerminateSessionOnExpiry": null,
+  "refreshInterval": null,
+  "authorizationFlow": null,
+  "nssUidOffset": null,
+  "nssGidOffset": null,
+  "challengeKey": null,
+  "challengeIdleTimeout": null,
+  "challengeTriggerCheckIn": null,
+  "jwtFederationProviders": null,
+} satisfies AgentConnectorRequest
+
+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 AgentConnectorRequest
+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/AgentPSSODeviceRegistrationRequest.md

@@ -0,0 +1,41 @@
+
+# AgentPSSODeviceRegistrationRequest
+
+Register Apple device via Platform SSO
+
+## Properties
+
+Name | Type
+------------ | -------------
+`deviceSigningKey` | string
+`deviceEncryptionKey` | string
+`signKeyId` | string
+`encKeyId` | string
+
+## Example
+
+```typescript
+import type { AgentPSSODeviceRegistrationRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "deviceSigningKey": null,
+  "deviceEncryptionKey": null,
+  "signKeyId": null,
+  "encKeyId": null,
+} satisfies AgentPSSODeviceRegistrationRequest
+
+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 AgentPSSODeviceRegistrationRequest
+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/AgentPSSODeviceRegistrationResponse.md

@@ -0,0 +1,45 @@
+
+# AgentPSSODeviceRegistrationResponse
+
+authentik settings for Platform SSO tokens
+
+## Properties
+
+Name | Type
+------------ | -------------
+`clientId` | string
+`issuer` | string
+`tokenEndpoint` | string
+`jwksEndpoint` | string
+`audience` | string
+`nonceEndpoint` | string
+
+## Example
+
+```typescript
+import type { AgentPSSODeviceRegistrationResponse } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "clientId": null,
+  "issuer": null,
+  "tokenEndpoint": null,
+  "jwksEndpoint": null,
+  "audience": null,
+  "nonceEndpoint": null,
+} satisfies AgentPSSODeviceRegistrationResponse
+
+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 AgentPSSODeviceRegistrationResponse
+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/AgentPSSOUserRegistrationRequest.md

@@ -0,0 +1,39 @@
+
+# AgentPSSOUserRegistrationRequest
+
+Register Apple device user via Platform SSO
+
+## Properties
+
+Name | Type
+------------ | -------------
+`userAuth` | string
+`userSecureEnclaveKey` | string
+`enclaveKeyId` | string
+
+## Example
+
+```typescript
+import type { AgentPSSOUserRegistrationRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "userAuth": null,
+  "userSecureEnclaveKey": null,
+  "enclaveKeyId": null,
+} satisfies AgentPSSOUserRegistrationRequest
+
+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 AgentPSSOUserRegistrationRequest
+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/AgentTokenResponse.md

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

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

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

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

@@ -0,0 +1,35 @@
+
+# AppleChallengeResponseRequest
+
+Pseudo class for apple response
+
+## Properties
+
+Name | Type
+------------ | -------------
+`component` | string
+
+## Example
+
+```typescript
+import type { AppleChallengeResponseRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "component": null,
+} satisfies AppleChallengeResponseRequest
+
+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 AppleChallengeResponseRequest
+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/AppleLoginChallenge.md

@@ -0,0 +1,47 @@
+
+# AppleLoginChallenge
+
+Special challenge for apple-native authentication flow, which happens on the client.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`flowInfo` | [ContextualFlowInfo](ContextualFlowInfo.md)
+`component` | string
+`responseErrors` | { [key: string]: Array<ErrorDetail>; }
+`clientId` | string
+`scope` | string
+`redirectUri` | string
+`state` | string
+
+## Example
+
+```typescript
+import type { AppleLoginChallenge } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "flowInfo": null,
+  "component": null,
+  "responseErrors": null,
+  "clientId": null,
+  "scope": null,
+  "redirectUri": null,
+  "state": null,
+} satisfies AppleLoginChallenge
+
+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 AppleLoginChallenge
+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/Application.md

@@ -0,0 +1,65 @@
+
+# Application
+
+Application Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | string
+`name` | string
+`slug` | string
+`provider` | number
+`providerObj` | [Provider](Provider.md)
+`backchannelProviders` | Array<number>
+`backchannelProvidersObj` | [Array<Provider>](Provider.md)
+`launchUrl` | string
+`openInNewTab` | boolean
+`metaLaunchUrl` | string
+`metaIcon` | string
+`metaIconUrl` | string
+`metaDescription` | string
+`metaPublisher` | string
+`policyEngineMode` | [PolicyEngineMode](PolicyEngineMode.md)
+`group` | string
+
+## Example
+
+```typescript
+import type { Application } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pk": null,
+  "name": null,
+  "slug": null,
+  "provider": null,
+  "providerObj": null,
+  "backchannelProviders": null,
+  "backchannelProvidersObj": null,
+  "launchUrl": null,
+  "openInNewTab": null,
+  "metaLaunchUrl": null,
+  "metaIcon": null,
+  "metaIconUrl": null,
+  "metaDescription": null,
+  "metaPublisher": null,
+  "policyEngineMode": null,
+  "group": null,
+} satisfies Application
+
+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 Application
+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/ApplicationEntitlement.md

@@ -0,0 +1,41 @@
+
+# ApplicationEntitlement
+
+ApplicationEntitlement Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pbmUuid` | string
+`name` | string
+`app` | string
+`attributes` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { ApplicationEntitlement } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "pbmUuid": null,
+  "name": null,
+  "app": null,
+  "attributes": null,
+} satisfies ApplicationEntitlement
+
+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 ApplicationEntitlement
+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)
+
+