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

package/docs/CurrentBrand.md

@@ -0,0 +1,63 @@
+
+# CurrentBrand
+
+Partial brand information for styling
+
+## Properties
+
+Name | Type
+------------ | -------------
+`matchedDomain` | string
+`brandingTitle` | string
+`brandingLogo` | string
+`brandingFavicon` | string
+`brandingCustomCss` | string
+`uiFooterLinks` | [Array<FooterLink>](FooterLink.md)
+`uiTheme` | [UiThemeEnum](UiThemeEnum.md)
+`flowAuthentication` | string
+`flowInvalidation` | string
+`flowRecovery` | string
+`flowUnenrollment` | string
+`flowUserSettings` | string
+`flowDeviceCode` | string
+`defaultLocale` | string
+`flags` | [CurrentBrandFlags](CurrentBrandFlags.md)
+
+## Example
+
+```typescript
+import type { CurrentBrand } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "matchedDomain": null,
+  "brandingTitle": null,
+  "brandingLogo": null,
+  "brandingFavicon": null,
+  "brandingCustomCss": null,
+  "uiFooterLinks": null,
+  "uiTheme": null,
+  "flowAuthentication": null,
+  "flowInvalidation": null,
+  "flowRecovery": null,
+  "flowUnenrollment": null,
+  "flowUserSettings": null,
+  "flowDeviceCode": null,
+  "defaultLocale": null,
+  "flags": null,
+} satisfies CurrentBrand
+
+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 CurrentBrand
+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/CurrentBrandFlags.md

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

@@ -0,0 +1,47 @@
+
+# DataExport
+
+Mixin to validate that a valid enterprise license exists before allowing to save the object
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`requestedBy` | [PartialUser](PartialUser.md)
+`requestedOn` | Date
+`contentType` | [ContentType](ContentType.md)
+`queryParams` | { [key: string]: any; }
+`fileUrl` | string
+`completed` | boolean
+
+## Example
+
+```typescript
+import type { DataExport } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "requestedBy": null,
+  "requestedOn": null,
+  "contentType": null,
+  "queryParams": null,
+  "fileUrl": null,
+  "completed": null,
+} satisfies DataExport
+
+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 DataExport
+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/DeliveryMethodEnum.md

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

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

@@ -0,0 +1,49 @@
+
+# DenyStage
+
+DenyStage Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pk` | string
+`name` | string
+`component` | string
+`verboseName` | string
+`verboseNamePlural` | string
+`metaModelName` | string
+`flowSet` | [Array<FlowSet>](FlowSet.md)
+`denyMessage` | string
+
+## Example
+
+```typescript
+import type { DenyStage } 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,
+  "denyMessage": null,
+} satisfies DenyStage
+
+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 DenyStage
+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/DenyStageRequest.md

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

@@ -0,0 +1,36 @@
+
+# DetailedCountry
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | [CountryCodeEnum](CountryCodeEnum.md)
+`name` | string
+
+## Example
+
+```typescript
+import type { DetailedCountry } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": null,
+  "name": null,
+} satisfies DetailedCountry
+
+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 DetailedCountry
+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/DetailedCountryField.md

@@ -0,0 +1,36 @@
+
+# DetailedCountryField
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | [CountryCodeEnum](CountryCodeEnum.md)
+`name` | string
+
+## Example
+
+```typescript
+import type { DetailedCountryField } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": null,
+  "name": null,
+} satisfies DetailedCountryField
+
+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 DetailedCountryField
+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/Device.md

@@ -0,0 +1,57 @@
+
+# Device
+
+Serializer for authenticator devices
+
+## Properties
+
+Name | Type
+------------ | -------------
+`verboseName` | string
+`verboseNamePlural` | string
+`metaModelName` | string
+`pk` | string
+`name` | string
+`type` | string
+`confirmed` | boolean
+`created` | Date
+`lastUpdated` | Date
+`lastUsed` | Date
+`extraDescription` | string
+`externalId` | string
+
+## Example
+
+```typescript
+import type { Device } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "verboseName": null,
+  "verboseNamePlural": null,
+  "metaModelName": null,
+  "pk": null,
+  "name": null,
+  "type": null,
+  "confirmed": null,
+  "created": null,
+  "lastUpdated": null,
+  "lastUsed": null,
+  "extraDescription": null,
+  "externalId": null,
+} satisfies Device
+
+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 Device
+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/DeviceAccessGroup.md

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

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

@@ -0,0 +1,41 @@
+
+# DeviceChallenge
+
+Single device challenge
+
+## Properties
+
+Name | Type
+------------ | -------------
+`deviceClass` | [DeviceClassesEnum](DeviceClassesEnum.md)
+`deviceUid` | string
+`challenge` | { [key: string]: any; }
+`lastUsed` | Date
+
+## Example
+
+```typescript
+import type { DeviceChallenge } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "deviceClass": null,
+  "deviceUid": null,
+  "challenge": null,
+  "lastUsed": null,
+} satisfies DeviceChallenge
+
+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 DeviceChallenge
+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/DeviceChallengeRequest.md

@@ -0,0 +1,41 @@
+
+# DeviceChallengeRequest
+
+Single device challenge
+
+## Properties
+
+Name | Type
+------------ | -------------
+`deviceClass` | [DeviceClassesEnum](DeviceClassesEnum.md)
+`deviceUid` | string
+`challenge` | { [key: string]: any; }
+`lastUsed` | Date
+
+## Example
+
+```typescript
+import type { DeviceChallengeRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "deviceClass": null,
+  "deviceUid": null,
+  "challenge": null,
+  "lastUsed": null,
+} satisfies DeviceChallengeRequest
+
+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 DeviceChallengeRequest
+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/DeviceClassesEnum.md

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

@@ -0,0 +1,40 @@
+
+# DeviceConnection
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`device` | string
+`connector` | string
+`connectorObj` | [Connector](Connector.md)
+`latestSnapshot` | [DeviceFactSnapshot](DeviceFactSnapshot.md)
+
+## Example
+
+```typescript
+import type { DeviceConnection } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "device": null,
+  "connector": null,
+  "connectorObj": null,
+  "latestSnapshot": null,
+} satisfies DeviceConnection
+
+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 DeviceConnection
+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/DeviceFactSnapshot.md

@@ -0,0 +1,40 @@
+
+# DeviceFactSnapshot
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [DeviceFacts](DeviceFacts.md)
+`connection` | string
+`created` | Date
+`expires` | Date
+
+## Example
+
+```typescript
+import type { DeviceFactSnapshot } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "connection": null,
+  "created": null,
+  "expires": null,
+} satisfies DeviceFactSnapshot
+
+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 DeviceFactSnapshot
+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)
+
+