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

package/docs/AuthenticatorDuoStageManualDeviceImportRequest.md

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

@@ -0,0 +1,49 @@
+
+# AuthenticatorDuoStageRequest
+
+AuthenticatorDuoStage Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`configureFlow` | string
+`friendlyName` | string
+`clientId` | string
+`clientSecret` | string
+`apiHostname` | string
+`adminIntegrationKey` | string
+`adminSecretKey` | string
+
+## Example
+
+```typescript
+import type { AuthenticatorDuoStageRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "configureFlow": null,
+  "friendlyName": null,
+  "clientId": null,
+  "clientSecret": null,
+  "apiHostname": null,
+  "adminIntegrationKey": null,
+  "adminSecretKey": null,
+} satisfies AuthenticatorDuoStageRequest
+
+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 AuthenticatorDuoStageRequest
+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/AuthenticatorEmailChallenge.md

@@ -0,0 +1,47 @@
+
+# AuthenticatorEmailChallenge
+
+Authenticator Email Setup challenge
+
+## Properties
+
+Name | Type
+------------ | -------------
+`flowInfo` | [ContextualFlowInfo](ContextualFlowInfo.md)
+`component` | string
+`responseErrors` | { [key: string]: Array<ErrorDetail>; }
+`pendingUser` | string
+`pendingUserAvatar` | string
+`email` | string
+`emailRequired` | boolean
+
+## Example
+
+```typescript
+import type { AuthenticatorEmailChallenge } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "flowInfo": null,
+  "component": null,
+  "responseErrors": null,
+  "pendingUser": null,
+  "pendingUserAvatar": null,
+  "email": null,
+  "emailRequired": null,
+} satisfies AuthenticatorEmailChallenge
+
+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 AuthenticatorEmailChallenge
+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/AuthenticatorEmailChallengeResponseRequest.md

@@ -0,0 +1,39 @@
+
+# AuthenticatorEmailChallengeResponseRequest
+
+Authenticator Email Challenge response, device is set by get_response_instance
+
+## Properties
+
+Name | Type
+------------ | -------------
+`component` | string
+`code` | string
+`email` | string
+
+## Example
+
+```typescript
+import type { AuthenticatorEmailChallengeResponseRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "component": null,
+  "code": null,
+  "email": null,
+} satisfies AuthenticatorEmailChallengeResponseRequest
+
+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 AuthenticatorEmailChallengeResponseRequest
+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/AuthenticatorEmailStage.md

@@ -0,0 +1,75 @@
+
+# AuthenticatorEmailStage
+
+AuthenticatorEmailStage 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
+`useGlobalSettings` | boolean
+`host` | string
+`port` | number
+`username` | string
+`password` | string
+`useTls` | boolean
+`useSsl` | boolean
+`timeout` | number
+`fromAddress` | string
+`subject` | string
+`tokenExpiry` | string
+`template` | string
+
+## Example
+
+```typescript
+import type { AuthenticatorEmailStage } 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,
+  "useGlobalSettings": null,
+  "host": null,
+  "port": null,
+  "username": null,
+  "password": null,
+  "useTls": null,
+  "useSsl": null,
+  "timeout": null,
+  "fromAddress": null,
+  "subject": null,
+  "tokenExpiry": null,
+  "template": null,
+} satisfies AuthenticatorEmailStage
+
+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 AuthenticatorEmailStage
+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/AuthenticatorEmailStageRequest.md

@@ -0,0 +1,63 @@
+
+# AuthenticatorEmailStageRequest
+
+AuthenticatorEmailStage Serializer
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`configureFlow` | string
+`friendlyName` | string
+`useGlobalSettings` | boolean
+`host` | string
+`port` | number
+`username` | string
+`password` | string
+`useTls` | boolean
+`useSsl` | boolean
+`timeout` | number
+`fromAddress` | string
+`subject` | string
+`tokenExpiry` | string
+`template` | string
+
+## Example
+
+```typescript
+import type { AuthenticatorEmailStageRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "configureFlow": null,
+  "friendlyName": null,
+  "useGlobalSettings": null,
+  "host": null,
+  "port": null,
+  "username": null,
+  "password": null,
+  "useTls": null,
+  "useSsl": null,
+  "timeout": null,
+  "fromAddress": null,
+  "subject": null,
+  "tokenExpiry": null,
+  "template": null,
+} satisfies AuthenticatorEmailStageRequest
+
+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 AuthenticatorEmailStageRequest
+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/AuthenticatorEndpointGDTCStage.md

@@ -0,0 +1,53 @@
+
+# AuthenticatorEndpointGDTCStage
+
+AuthenticatorEndpointGDTCStage 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
+`credentials` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { AuthenticatorEndpointGDTCStage } 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,
+  "credentials": null,
+} satisfies AuthenticatorEndpointGDTCStage
+
+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 AuthenticatorEndpointGDTCStage
+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/AuthenticatorEndpointGDTCStageRequest.md

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

@@ -0,0 +1,45 @@
+
+# AuthenticatorSMSChallenge
+
+SMS Setup challenge
+
+## Properties
+
+Name | Type
+------------ | -------------
+`flowInfo` | [ContextualFlowInfo](ContextualFlowInfo.md)
+`component` | string
+`responseErrors` | { [key: string]: Array<ErrorDetail>; }
+`pendingUser` | string
+`pendingUserAvatar` | string
+`phoneNumberRequired` | boolean
+
+## Example
+
+```typescript
+import type { AuthenticatorSMSChallenge } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "flowInfo": null,
+  "component": null,
+  "responseErrors": null,
+  "pendingUser": null,
+  "pendingUserAvatar": null,
+  "phoneNumberRequired": null,
+} satisfies AuthenticatorSMSChallenge
+
+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 AuthenticatorSMSChallenge
+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/AuthenticatorSMSChallengeResponseRequest.md

@@ -0,0 +1,39 @@
+
+# AuthenticatorSMSChallengeResponseRequest
+
+SMS Challenge response, device is set by get_response_instance
+
+## Properties
+
+Name | Type
+------------ | -------------
+`component` | string
+`code` | string
+`phoneNumber` | string
+
+## Example
+
+```typescript
+import type { AuthenticatorSMSChallengeResponseRequest } from '@goauthentik/api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "component": null,
+  "code": null,
+  "phoneNumber": null,
+} satisfies AuthenticatorSMSChallengeResponseRequest
+
+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 AuthenticatorSMSChallengeResponseRequest
+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/AuthenticatorSMSStage.md

@@ -0,0 +1,67 @@
+
+# AuthenticatorSMSStage
+
+AuthenticatorSMSStage 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
+`provider` | [ProviderEnum](ProviderEnum.md)
+`fromNumber` | string
+`accountSid` | string
+`auth` | string
+`authPassword` | string
+`authType` | [AuthTypeEnum](AuthTypeEnum.md)
+`verifyOnly` | boolean
+`mapping` | string
+
+## Example
+
+```typescript
+import type { AuthenticatorSMSStage } 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,
+  "provider": null,
+  "fromNumber": null,
+  "accountSid": null,
+  "auth": null,
+  "authPassword": null,
+  "authType": null,
+  "verifyOnly": null,
+  "mapping": null,
+} satisfies AuthenticatorSMSStage
+
+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 AuthenticatorSMSStage
+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/AuthenticatorSMSStageRequest.md

@@ -0,0 +1,55 @@
+
+# AuthenticatorSMSStageRequest
+
+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 { AuthenticatorSMSStageRequest } 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 AuthenticatorSMSStageRequest
+
+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 AuthenticatorSMSStageRequest
+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/AuthenticatorStaticChallenge.md

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

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