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

package/docs/PatchedAuthenticatorSMSStageRequest.md

@@ -0,0 +1,55 @@
+
+# PatchedAuthenticatorSMSStageRequest
+
+AuthenticatorSMSStage Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`configureFlow` | string
+`friendlyName` | string
+`provider` | [ProviderEnum](ProviderEnum.md)
+`fromNumber` | string
+`accountSid` | string
+`auth` | string
+`authPassword` | string
+`authType` | [AuthTypeEnum](AuthTypeEnum.md)
+`verifyOnly` | boolean
+`mapping` | string
+
+## Example
+
+```typescript
+import type { PatchedAuthenticatorSMSStageRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "configureFlow": null,
+  "friendlyName": null,
+  "provider": null,
+  "fromNumber": null,
+  "accountSid": null,
+  "auth": null,
+  "authPassword": null,
+  "authType": null,
+  "verifyOnly": null,
+  "mapping": null,
+} satisfies PatchedAuthenticatorSMSStageRequest
+
+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 PatchedAuthenticatorSMSStageRequest
+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/PatchedAuthenticatorStaticStageRequest.md

@@ -0,0 +1,43 @@
+
+# PatchedAuthenticatorStaticStageRequest
+
+AuthenticatorStaticStage Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`configureFlow` | string
+`friendlyName` | string
+`tokenCount` | number
+`tokenLength` | number
+
+## Example
+
+```typescript
+import type { PatchedAuthenticatorStaticStageRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "configureFlow": null,
+  "friendlyName": null,
+  "tokenCount": null,
+  "tokenLength": null,
+} satisfies PatchedAuthenticatorStaticStageRequest
+
+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 PatchedAuthenticatorStaticStageRequest
+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/PatchedAuthenticatorTOTPStageRequest.md

@@ -0,0 +1,41 @@
+
+# PatchedAuthenticatorTOTPStageRequest
+
+AuthenticatorTOTPStage Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`configureFlow` | string
+`friendlyName` | string
+`digits` | [DigitsEnum](DigitsEnum.md)
+
+## Example
+
+```typescript
+import type { PatchedAuthenticatorTOTPStageRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "configureFlow": null,
+  "friendlyName": null,
+  "digits": null,
+} satisfies PatchedAuthenticatorTOTPStageRequest
+
+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 PatchedAuthenticatorTOTPStageRequest
+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/PatchedAuthenticatorValidateStageRequest.md

@@ -0,0 +1,47 @@
+
+# PatchedAuthenticatorValidateStageRequest
+
+AuthenticatorValidateStage Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`notConfiguredAction` | [NotConfiguredActionEnum](NotConfiguredActionEnum.md)
+`deviceClasses` | [Array<DeviceClassesEnum>](DeviceClassesEnum.md)
+`configurationStages` | Array<string>
+`lastAuthThreshold` | string
+`webauthnUserVerification` | [UserVerificationEnum](UserVerificationEnum.md)
+`webauthnAllowedDeviceTypes` | Array<string>
+
+## Example
+
+```typescript
+import type { PatchedAuthenticatorValidateStageRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "notConfiguredAction": null,
+  "deviceClasses": null,
+  "configurationStages": null,
+  "lastAuthThreshold": null,
+  "webauthnUserVerification": null,
+  "webauthnAllowedDeviceTypes": null,
+} satisfies PatchedAuthenticatorValidateStageRequest
+
+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 PatchedAuthenticatorValidateStageRequest
+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/PatchedAuthenticatorWebAuthnStageRequest.md

@@ -0,0 +1,49 @@
+
+# PatchedAuthenticatorWebAuthnStageRequest
+
+AuthenticatorWebAuthnStage Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`configureFlow` | string
+`friendlyName` | string
+`userVerification` | [UserVerificationEnum](UserVerificationEnum.md)
+`authenticatorAttachment` | [AuthenticatorAttachmentEnum](AuthenticatorAttachmentEnum.md)
+`residentKeyRequirement` | [ResidentKeyRequirementEnum](ResidentKeyRequirementEnum.md)
+`deviceTypeRestrictions` | Array<string>
+`maxAttempts` | number
+
+## Example
+
+```typescript
+import type { PatchedAuthenticatorWebAuthnStageRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "configureFlow": null,
+  "friendlyName": null,
+  "userVerification": null,
+  "authenticatorAttachment": null,
+  "residentKeyRequirement": null,
+  "deviceTypeRestrictions": null,
+  "maxAttempts": null,
+} satisfies PatchedAuthenticatorWebAuthnStageRequest
+
+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 PatchedAuthenticatorWebAuthnStageRequest
+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/PatchedBlueprintInstanceRequest.md

@@ -0,0 +1,43 @@
+
+# PatchedBlueprintInstanceRequest
+
+Info about a single blueprint instance file
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`path` | string
+`context` | { [key: string]: any; }
+`enabled` | boolean
+`content` | string
+
+## Example
+
+```typescript
+import type { PatchedBlueprintInstanceRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "path": null,
+  "context": null,
+  "enabled": null,
+  "content": null,
+} satisfies PatchedBlueprintInstanceRequest
+
+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 PatchedBlueprintInstanceRequest
+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/PatchedBrandRequest.md

@@ -0,0 +1,67 @@
+
+# PatchedBrandRequest
+
+Brand Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`domain` | string
+`_default` | boolean
+`brandingTitle` | string
+`brandingLogo` | string
+`brandingFavicon` | string
+`brandingCustomCss` | string
+`brandingDefaultFlowBackground` | string
+`flowAuthentication` | string
+`flowInvalidation` | string
+`flowRecovery` | string
+`flowUnenrollment` | string
+`flowUserSettings` | string
+`flowDeviceCode` | string
+`defaultApplication` | string
+`webCertificate` | string
+`clientCertificates` | Array<string>
+`attributes` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { PatchedBrandRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "domain": null,
+  "_default": null,
+  "brandingTitle": null,
+  "brandingLogo": null,
+  "brandingFavicon": null,
+  "brandingCustomCss": null,
+  "brandingDefaultFlowBackground": null,
+  "flowAuthentication": null,
+  "flowInvalidation": null,
+  "flowRecovery": null,
+  "flowUnenrollment": null,
+  "flowUserSettings": null,
+  "flowDeviceCode": null,
+  "defaultApplication": null,
+  "webCertificate": null,
+  "clientCertificates": null,
+  "attributes": null,
+} satisfies PatchedBrandRequest
+
+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 PatchedBrandRequest
+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/PatchedCaptchaStageRequest.md

@@ -0,0 +1,51 @@
+
+# PatchedCaptchaStageRequest
+
+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 { PatchedCaptchaStageRequest } 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 PatchedCaptchaStageRequest
+
+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 PatchedCaptchaStageRequest
+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/PatchedCertificateKeyPairRequest.md

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

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

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

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

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

@@ -0,0 +1,53 @@
+
+# PatchedDeviceUserBindingRequest
+
+PolicyBinding Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`policy` | string
+`group` | string
+`user` | number
+`target` | string
+`negate` | boolean
+`enabled` | boolean
+`order` | number
+`timeout` | number
+`failureResult` | boolean
+`isPrimary` | boolean
+
+## Example
+
+```typescript
+import type { PatchedDeviceUserBindingRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "policy": null,
+  "group": null,
+  "user": null,
+  "target": null,
+  "negate": null,
+  "enabled": null,
+  "order": null,
+  "timeout": null,
+  "failureResult": null,
+  "isPrimary": null,
+} satisfies PatchedDeviceUserBindingRequest
+
+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 PatchedDeviceUserBindingRequest
+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/PatchedDockerServiceConnectionRequest.md

@@ -0,0 +1,43 @@
+
+# PatchedDockerServiceConnectionRequest
+
+DockerServiceConnection Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`local` | boolean
+`url` | string
+`tlsVerification` | string
+`tlsAuthentication` | string
+
+## Example
+
+```typescript
+import type { PatchedDockerServiceConnectionRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "local": null,
+  "url": null,
+  "tlsVerification": null,
+  "tlsAuthentication": null,
+} satisfies PatchedDockerServiceConnectionRequest
+
+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 PatchedDockerServiceConnectionRequest
+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)
+
+