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

package/docs/ApplicationEntitlementRequest.md

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

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

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

@@ -0,0 +1,53 @@
+
+# AuthenticatedSession
+
+AuthenticatedSession Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`uuid` | string
+`current` | boolean
+`userAgent` | [AuthenticatedSessionUserAgent](AuthenticatedSessionUserAgent.md)
+`geoIp` | [AuthenticatedSessionGeoIp](AuthenticatedSessionGeoIp.md)
+`asn` | [AuthenticatedSessionAsn](AuthenticatedSessionAsn.md)
+`user` | number
+`lastIp` | string
+`lastUserAgent` | string
+`lastUsed` | Date
+`expires` | Date
+
+## Example
+
+```typescript
+import type { AuthenticatedSession } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "uuid": null,
+  "current": null,
+  "userAgent": null,
+  "geoIp": null,
+  "asn": null,
+  "user": null,
+  "lastIp": null,
+  "lastUserAgent": null,
+  "lastUsed": null,
+  "expires": null,
+} satisfies AuthenticatedSession
+
+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 AuthenticatedSession
+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/AuthenticatedSessionAsn.md

@@ -0,0 +1,39 @@
+
+# AuthenticatedSessionAsn
+
+Get ASN Data
+
+## Properties
+
+Name | Type
+------------ | -------------
+`asn` | number
+`asOrg` | string
+`network` | string
+
+## Example
+
+```typescript
+import type { AuthenticatedSessionAsn } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "asn": null,
+  "asOrg": null,
+  "network": null,
+} satisfies AuthenticatedSessionAsn
+
+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 AuthenticatedSessionAsn
+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/AuthenticatedSessionGeoIp.md

@@ -0,0 +1,43 @@
+
+# AuthenticatedSessionGeoIp
+
+Get GeoIP Data
+
+## Properties
+
+Name | Type
+------------ | -------------
+`continent` | string
+`country` | string
+`lat` | number
+`_long` | number
+`city` | string
+
+## Example
+
+```typescript
+import type { AuthenticatedSessionGeoIp } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "continent": null,
+  "country": null,
+  "lat": null,
+  "_long": null,
+  "city": null,
+} satisfies AuthenticatedSessionGeoIp
+
+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 AuthenticatedSessionGeoIp
+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/AuthenticatedSessionUserAgent.md

@@ -0,0 +1,41 @@
+
+# AuthenticatedSessionUserAgent
+
+Get parsed user agent
+
+## Properties
+
+Name | Type
+------------ | -------------
+`device` | [AuthenticatedSessionUserAgentDevice](AuthenticatedSessionUserAgentDevice.md)
+`os` | [AuthenticatedSessionUserAgentOs](AuthenticatedSessionUserAgentOs.md)
+`userAgent` | [AuthenticatedSessionUserAgentUserAgent](AuthenticatedSessionUserAgentUserAgent.md)
+`string` | string
+
+## Example
+
+```typescript
+import type { AuthenticatedSessionUserAgent } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "device": null,
+  "os": null,
+  "userAgent": null,
+  "string": null,
+} satisfies AuthenticatedSessionUserAgent
+
+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 AuthenticatedSessionUserAgent
+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/AuthenticatedSessionUserAgentDevice.md

@@ -0,0 +1,39 @@
+
+# AuthenticatedSessionUserAgentDevice
+
+User agent device
+
+## Properties
+
+Name | Type
+------------ | -------------
+`brand` | string
+`family` | string
+`model` | string
+
+## Example
+
+```typescript
+import type { AuthenticatedSessionUserAgentDevice } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "brand": null,
+  "family": null,
+  "model": null,
+} satisfies AuthenticatedSessionUserAgentDevice
+
+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 AuthenticatedSessionUserAgentDevice
+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/AuthenticatedSessionUserAgentOs.md

@@ -0,0 +1,43 @@
+
+# AuthenticatedSessionUserAgentOs
+
+User agent os
+
+## Properties
+
+Name | Type
+------------ | -------------
+`family` | string
+`major` | string
+`minor` | string
+`patch` | string
+`patchMinor` | string
+
+## Example
+
+```typescript
+import type { AuthenticatedSessionUserAgentOs } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "family": null,
+  "major": null,
+  "minor": null,
+  "patch": null,
+  "patchMinor": null,
+} satisfies AuthenticatedSessionUserAgentOs
+
+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 AuthenticatedSessionUserAgentOs
+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/AuthenticatedSessionUserAgentUserAgent.md

@@ -0,0 +1,41 @@
+
+# AuthenticatedSessionUserAgentUserAgent
+
+User agent browser
+
+## Properties
+
+Name | Type
+------------ | -------------
+`family` | string
+`major` | string
+`minor` | string
+`patch` | string
+
+## Example
+
+```typescript
+import type { AuthenticatedSessionUserAgentUserAgent } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "family": null,
+  "major": null,
+  "minor": null,
+  "patch": null,
+} satisfies AuthenticatedSessionUserAgentUserAgent
+
+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 AuthenticatedSessionUserAgentUserAgent
+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/AuthenticationEnum.md

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

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

@@ -0,0 +1,49 @@
+
+# AuthenticatorDuoChallenge
+
+Duo Challenge
+
+## Properties
+
+Name | Type
+------------ | -------------
+`flowInfo` | [ContextualFlowInfo](ContextualFlowInfo.md)
+`component` | string
+`responseErrors` | { [key: string]: Array<ErrorDetail>; }
+`pendingUser` | string
+`pendingUserAvatar` | string
+`activationBarcode` | string
+`activationCode` | string
+`stageUuid` | string
+
+## Example
+
+```typescript
+import type { AuthenticatorDuoChallenge } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "flowInfo": null,
+  "component": null,
+  "responseErrors": null,
+  "pendingUser": null,
+  "pendingUserAvatar": null,
+  "activationBarcode": null,
+  "activationCode": null,
+  "stageUuid": null,
+} satisfies AuthenticatorDuoChallenge
+
+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 AuthenticatorDuoChallenge
+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/AuthenticatorDuoChallengeResponseRequest.md

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

@@ -0,0 +1,57 @@
+
+# AuthenticatorDuoStage
+
+AuthenticatorDuoStage Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | string
+`name` | string
+`component` | string
+`verboseName` | string
+`verboseNamePlural` | string
+`metaModelName` | string
+`flowSet` | [Array<FlowSet>](FlowSet.md)
+`configureFlow` | string
+`friendlyName` | string
+`clientId` | string
+`apiHostname` | string
+`adminIntegrationKey` | string
+
+## Example
+
+```typescript
+import type { AuthenticatorDuoStage } 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,
+  "configureFlow": null,
+  "friendlyName": null,
+  "clientId": null,
+  "apiHostname": null,
+  "adminIntegrationKey": null,
+} satisfies AuthenticatorDuoStage
+
+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 AuthenticatorDuoStage
+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/AuthenticatorDuoStageDeviceImportResponse.md

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