@goauthentik/api 2023.2.2-1677507715 → 2023.2.2-1678200024

package/dist/models/Flow.d.ts

@@ -52,12 +52,21 @@ export interface Flow {
     title: string;
     /**
      * Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
+     *
+     * * `authentication` - Authentication
+     * * `authorization` - Authorization
+     * * `invalidation` - Invalidation
+     * * `enrollment` - Enrollment
+     * * `unenrollment` - Unrenollment
+     * * `recovery` - Recovery
+     * * `stage_configuration` - Stage Configuration
      * @type {FlowDesignationEnum}
      * @memberof Flow
      */
     designation: FlowDesignationEnum | null;
     /**
-     *
+     * Get the URL to the background image. If the name is /static or starts with http
+     * it is returned as-is
      * @type {string}
      * @memberof Flow
      */
@@ -75,7 +84,7 @@ export interface Flow {
      */
     readonly policies: Array<string>;
     /**
-     *
+     * Get count of cached flows
      * @type {number}
      * @memberof Flow
      */
@@ -93,7 +102,7 @@ export interface Flow {
      */
     compatibilityMode?: boolean;
     /**
-     *
+     * Get export URL for flow
      * @type {string}
      * @memberof Flow
      */
@@ -106,12 +115,21 @@ export interface Flow {
     layout?: LayoutEnum;
     /**
      * Configure what should happen when a flow denies access to a user.
+     *
+     * * `message_continue` - Message Continue
+     * * `message` - Message
+     * * `continue` - Continue
      * @type {DeniedActionEnum}
      * @memberof Flow
      */
     deniedAction?: DeniedActionEnum | null;
     /**
      * Required level of authentication and authorization to access a flow.
+     *
+     * * `none` - None
+     * * `require_authenticated` - Require Authenticated
+     * * `require_unauthenticated` - Require Unauthenticated
+     * * `require_superuser` - Require Superuser
      * @type {AuthenticationEnum}
      * @memberof Flow
      */

package/dist/models/FlowDesignationEnum.d.ts

@@ -10,7 +10,13 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `authentication` - Authentication
+ * * `authorization` - Authorization
+ * * `invalidation` - Invalidation
+ * * `enrollment` - Enrollment
+ * * `unenrollment` - Unrenollment
+ * * `recovery` - Recovery
+ * * `stage_configuration` - Stage Configuration
  * @export
  */
 export declare const FlowDesignationEnum: {

package/dist/models/FlowDesignationEnum.js

@@ -15,7 +15,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FlowDesignationEnumToJSON = exports.FlowDesignationEnumFromJSONTyped = exports.FlowDesignationEnumFromJSON = exports.FlowDesignationEnum = void 0;
 /**
- *
+ * * `authentication` - Authentication
+ * * `authorization` - Authorization
+ * * `invalidation` - Invalidation
+ * * `enrollment` - Enrollment
+ * * `unenrollment` - Unrenollment
+ * * `recovery` - Recovery
+ * * `stage_configuration` - Stage Configuration
  * @export
  */
 exports.FlowDesignationEnum = {

package/dist/models/FlowInspectorPlan.d.ts

@@ -29,7 +29,7 @@ export interface FlowInspectorPlan {
      */
     nextPlannedStage: FlowInspectorPlanCurrentStage;
     /**
-     *
+     * Get the plan's context, sanitized
      * @type {{ [key: string]: any; }}
      * @memberof FlowInspectorPlan
      */
@@ -37,7 +37,7 @@ export interface FlowInspectorPlan {
         [key: string]: any;
     };
     /**
-     *
+     * Get a unique session ID
      * @type {string}
      * @memberof FlowInspectorPlan
      */

package/dist/models/FlowInspectorPlanCurrentStage.d.ts

@@ -74,6 +74,10 @@ export interface FlowInspectorPlanCurrentStage {
     policyEngineMode?: PolicyEngineMode;
     /**
      * Configure how the flow executor should handle an invalid response to a challenge. RETRY returns the error message and a similar challenge to the executor. RESTART restarts the flow from the beginning, and RESTART_WITH_CONTEXT restarts the flow while keeping the current context.
+     *
+     * * `retry` - Retry
+     * * `restart` - Restart
+     * * `restart_with_context` - Restart With Context
      * @type {InvalidResponseActionEnum}
      * @memberof FlowInspectorPlanCurrentStage
      */

package/dist/models/FlowRequest.d.ts

@@ -40,6 +40,14 @@ export interface FlowRequest {
     title: string;
     /**
      * Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
+     *
+     * * `authentication` - Authentication
+     * * `authorization` - Authorization
+     * * `invalidation` - Invalidation
+     * * `enrollment` - Enrollment
+     * * `unenrollment` - Unrenollment
+     * * `recovery` - Recovery
+     * * `stage_configuration` - Stage Configuration
      * @type {FlowDesignationEnum}
      * @memberof FlowRequest
      */
@@ -64,12 +72,21 @@ export interface FlowRequest {
     layout?: LayoutEnum;
     /**
      * Configure what should happen when a flow denies access to a user.
+     *
+     * * `message_continue` - Message Continue
+     * * `message` - Message
+     * * `continue` - Continue
      * @type {DeniedActionEnum}
      * @memberof FlowRequest
      */
     deniedAction?: DeniedActionEnum | null;
     /**
      * Required level of authentication and authorization to access a flow.
+     *
+     * * `none` - None
+     * * `require_authenticated` - Require Authenticated
+     * * `require_unauthenticated` - Require Unauthenticated
+     * * `require_superuser` - Require Superuser
      * @type {AuthenticationEnum}
      * @memberof FlowRequest
      */

package/dist/models/FlowSet.d.ts

@@ -51,12 +51,21 @@ export interface FlowSet {
     title: string;
     /**
      * Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
+     *
+     * * `authentication` - Authentication
+     * * `authorization` - Authorization
+     * * `invalidation` - Invalidation
+     * * `enrollment` - Enrollment
+     * * `unenrollment` - Unrenollment
+     * * `recovery` - Recovery
+     * * `stage_configuration` - Stage Configuration
      * @type {FlowDesignationEnum}
      * @memberof FlowSet
      */
     designation: FlowDesignationEnum | null;
     /**
-     *
+     * Get the URL to the background image. If the name is /static or starts with http
+     * it is returned as-is
      * @type {string}
      * @memberof FlowSet
      */
@@ -74,7 +83,7 @@ export interface FlowSet {
      */
     compatibilityMode?: boolean;
     /**
-     *
+     * Get export URL for flow
      * @type {string}
      * @memberof FlowSet
      */
@@ -87,6 +96,10 @@ export interface FlowSet {
     layout?: LayoutEnum;
     /**
      * Configure what should happen when a flow denies access to a user.
+     *
+     * * `message_continue` - Message Continue
+     * * `message` - Message
+     * * `continue` - Continue
      * @type {DeniedActionEnum}
      * @memberof FlowSet
      */

package/dist/models/FlowSetRequest.d.ts

@@ -39,6 +39,14 @@ export interface FlowSetRequest {
     title: string;
     /**
      * Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
+     *
+     * * `authentication` - Authentication
+     * * `authorization` - Authorization
+     * * `invalidation` - Invalidation
+     * * `enrollment` - Enrollment
+     * * `unenrollment` - Unrenollment
+     * * `recovery` - Recovery
+     * * `stage_configuration` - Stage Configuration
      * @type {FlowDesignationEnum}
      * @memberof FlowSetRequest
      */
@@ -63,6 +71,10 @@ export interface FlowSetRequest {
     layout?: LayoutEnum;
     /**
      * Configure what should happen when a flow denies access to a user.
+     *
+     * * `message_continue` - Message Continue
+     * * `message` - Message
+     * * `continue` - Continue
      * @type {DeniedActionEnum}
      * @memberof FlowSetRequest
      */

package/dist/models/FlowStageBinding.d.ts

@@ -74,6 +74,10 @@ export interface FlowStageBinding {
     policyEngineMode?: PolicyEngineMode;
     /**
      * Configure how the flow executor should handle an invalid response to a challenge. RETRY returns the error message and a similar challenge to the executor. RESTART restarts the flow from the beginning, and RESTART_WITH_CONTEXT restarts the flow while keeping the current context.
+     *
+     * * `retry` - Retry
+     * * `restart` - Restart
+     * * `restart_with_context` - Restart With Context
      * @type {InvalidResponseActionEnum}
      * @memberof FlowStageBinding
      */

package/dist/models/FlowStageBindingRequest.d.ts

@@ -55,6 +55,10 @@ export interface FlowStageBindingRequest {
     policyEngineMode?: PolicyEngineMode;
     /**
      * Configure how the flow executor should handle an invalid response to a challenge. RETRY returns the error message and a similar challenge to the executor. RESTART restarts the flow from the beginning, and RESTART_WITH_CONTEXT restarts the flow while keeping the current context.
+     *
+     * * `retry` - Retry
+     * * `restart` - Restart
+     * * `restart_with_context` - Restart With Context
      * @type {InvalidResponseActionEnum}
      * @memberof FlowStageBindingRequest
      */

package/dist/models/FlowStageBindingStageObj.d.ts

@@ -29,25 +29,25 @@ export interface FlowStageBindingStageObj {
      */
     name: string;
     /**
-     *
+     * Get object type so that we know how to edit the object
      * @type {string}
      * @memberof FlowStageBindingStageObj
      */
     readonly component: string;
     /**
-     *
+     * Return object's verbose_name
      * @type {string}
      * @memberof FlowStageBindingStageObj
      */
     readonly verboseName: string;
     /**
-     *
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof FlowStageBindingStageObj
      */
     readonly verboseNamePlural: string;
     /**
-     *
+     * Return internal model name
      * @type {string}
      * @memberof FlowStageBindingStageObj
      */

package/dist/models/IdentificationStage.d.ts

@@ -30,25 +30,25 @@ export interface IdentificationStage {
      */
     name: string;
     /**
-     *
+     * Get object type so that we know how to edit the object
      * @type {string}
      * @memberof IdentificationStage
      */
     readonly component: string;
     /**
-     *
+     * Return object's verbose_name
      * @type {string}
      * @memberof IdentificationStage
      */
     readonly verboseName: string;
     /**
-     *
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof IdentificationStage
      */
     readonly verboseNamePlural: string;
     /**
-     *
+     * Return internal model name
      * @type {string}
      * @memberof IdentificationStage
      */

package/dist/models/IntentEnum.d.ts

@@ -10,7 +10,10 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `verification` - Intent Verification
+ * * `api` - Intent Api
+ * * `recovery` - Intent Recovery
+ * * `app_password` - Intent App Password
  * @export
  */
 export declare const IntentEnum: {

package/dist/models/IntentEnum.js

@@ -15,7 +15,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IntentEnumToJSON = exports.IntentEnumFromJSONTyped = exports.IntentEnumFromJSON = exports.IntentEnum = void 0;
 /**
- *
+ * * `verification` - Intent Verification
+ * * `api` - Intent Api
+ * * `recovery` - Intent Recovery
+ * * `app_password` - Intent App Password
  * @export
  */
 exports.IntentEnum = {

package/dist/models/InvalidResponseActionEnum.d.ts

@@ -10,7 +10,9 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `retry` - Retry
+ * * `restart` - Restart
+ * * `restart_with_context` - Restart With Context
  * @export
  */
 export declare const InvalidResponseActionEnum: {

package/dist/models/InvalidResponseActionEnum.js

@@ -15,7 +15,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InvalidResponseActionEnumToJSON = exports.InvalidResponseActionEnumFromJSONTyped = exports.InvalidResponseActionEnumFromJSON = exports.InvalidResponseActionEnum = void 0;
 /**
- *
+ * * `retry` - Retry
+ * * `restart` - Restart
+ * * `restart_with_context` - Restart With Context
  * @export
  */
 exports.InvalidResponseActionEnum = {

package/dist/models/InvitationFlowObj.d.ts

@@ -52,12 +52,21 @@ export interface InvitationFlowObj {
     title: string;
     /**
      * Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
+     *
+     * * `authentication` - Authentication
+     * * `authorization` - Authorization
+     * * `invalidation` - Invalidation
+     * * `enrollment` - Enrollment
+     * * `unenrollment` - Unrenollment
+     * * `recovery` - Recovery
+     * * `stage_configuration` - Stage Configuration
      * @type {FlowDesignationEnum}
      * @memberof InvitationFlowObj
      */
     designation: FlowDesignationEnum | null;
     /**
-     *
+     * Get the URL to the background image. If the name is /static or starts with http
+     * it is returned as-is
      * @type {string}
      * @memberof InvitationFlowObj
      */
@@ -75,7 +84,7 @@ export interface InvitationFlowObj {
      */
     readonly policies: Array<string>;
     /**
-     *
+     * Get count of cached flows
      * @type {number}
      * @memberof InvitationFlowObj
      */
@@ -93,7 +102,7 @@ export interface InvitationFlowObj {
      */
     compatibilityMode?: boolean;
     /**
-     *
+     * Get export URL for flow
      * @type {string}
      * @memberof InvitationFlowObj
      */
@@ -106,12 +115,21 @@ export interface InvitationFlowObj {
     layout?: LayoutEnum;
     /**
      * Configure what should happen when a flow denies access to a user.
+     *
+     * * `message_continue` - Message Continue
+     * * `message` - Message
+     * * `continue` - Continue
      * @type {DeniedActionEnum}
      * @memberof InvitationFlowObj
      */
     deniedAction?: DeniedActionEnum | null;
     /**
      * Required level of authentication and authorization to access a flow.
+     *
+     * * `none` - None
+     * * `require_authenticated` - Require Authenticated
+     * * `require_unauthenticated` - Require Unauthenticated
+     * * `require_superuser` - Require Superuser
      * @type {AuthenticationEnum}
      * @memberof InvitationFlowObj
      */

package/dist/models/InvitationStage.d.ts

@@ -29,25 +29,25 @@ export interface InvitationStage {
      */
     name: string;
     /**
-     *
+     * Get object type so that we know how to edit the object
      * @type {string}
      * @memberof InvitationStage
      */
     readonly component: string;
     /**
-     *
+     * Return object's verbose_name
      * @type {string}
      * @memberof InvitationStage
      */
     readonly verboseName: string;
     /**
-     *
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof InvitationStage
      */
     readonly verboseNamePlural: string;
     /**
-     *
+     * Return internal model name
      * @type {string}
      * @memberof InvitationStage
      */

package/dist/models/IssuerModeEnum.d.ts

@@ -10,7 +10,8 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `global` - Same identifier is used for all providers
+ * * `per_provider` - Each provider has a different issuer, based on the application slug.
  * @export
  */
 export declare const IssuerModeEnum: {

package/dist/models/IssuerModeEnum.js

@@ -15,7 +15,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IssuerModeEnumToJSON = exports.IssuerModeEnumFromJSONTyped = exports.IssuerModeEnumFromJSON = exports.IssuerModeEnum = void 0;
 /**
- *
+ * * `global` - Same identifier is used for all providers
+ * * `per_provider` - Each provider has a different issuer, based on the application slug.
  * @export
  */
 exports.IssuerModeEnum = {

package/dist/models/KubernetesServiceConnection.d.ts

@@ -40,19 +40,19 @@ export interface KubernetesServiceConnection {
      */
     readonly component: string;
     /**
-     *
+     * Return object's verbose_name
      * @type {string}
      * @memberof KubernetesServiceConnection
      */
     readonly verboseName: string;
     /**
-     *
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof KubernetesServiceConnection
      */
     readonly verboseNamePlural: string;
     /**
-     *
+     * Return internal model name
      * @type {string}
      * @memberof KubernetesServiceConnection
      */

package/dist/models/LDAPAPIAccessMode.d.ts

@@ -10,7 +10,8 @@
  * Do not edit the class manually.
  */
 /**
- *
+ * * `direct` - Direct
+ * * `cached` - Cached
  * @export
  */
 export declare const LDAPAPIAccessMode: {

package/dist/models/LDAPAPIAccessMode.js

@@ -15,7 +15,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LDAPAPIAccessModeToJSON = exports.LDAPAPIAccessModeFromJSONTyped = exports.LDAPAPIAccessModeFromJSON = exports.LDAPAPIAccessMode = void 0;
 /**
- *
+ * * `direct` - Direct
+ * * `cached` - Cached
  * @export
  */
 exports.LDAPAPIAccessMode = {

package/dist/models/LDAPPropertyMapping.d.ts

@@ -40,25 +40,25 @@ export interface LDAPPropertyMapping {
      */
     expression: string;
     /**
-     *
+     * Get object's component so that we know how to edit the object
      * @type {string}
      * @memberof LDAPPropertyMapping
      */
     readonly component: string;
     /**
-     *
+     * Return object's verbose_name
      * @type {string}
      * @memberof LDAPPropertyMapping
      */
     readonly verboseName: string;
     /**
-     *
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof LDAPPropertyMapping
      */
     readonly verboseNamePlural: string;
     /**
-     *
+     * Return internal model name
      * @type {string}
      * @memberof LDAPPropertyMapping
      */

package/dist/models/LDAPProvider.d.ts

@@ -33,7 +33,7 @@ export interface LDAPProvider {
      * @type {string}
      * @memberof LDAPProvider
      */
-    authorizationFlow: string;
+    authorizationFlow?: string | null;
     /**
      *
      * @type {Array<string>}
@@ -41,7 +41,7 @@ export interface LDAPProvider {
      */
     propertyMappings?: Array<string>;
     /**
-     *
+     * Get object component so that we know how to edit the object
      * @type {string}
      * @memberof LDAPProvider
      */
@@ -59,19 +59,19 @@ export interface LDAPProvider {
      */
     readonly assignedApplicationName: string;
     /**
-     *
+     * Return object's verbose_name
      * @type {string}
      * @memberof LDAPProvider
      */
     readonly verboseName: string;
     /**
-     *
+     * Return object's plural verbose_name
      * @type {string}
      * @memberof LDAPProvider
      */
     readonly verboseNamePlural: string;
     /**
-     *
+     * Return internal model name
      * @type {string}
      * @memberof LDAPProvider
      */

package/dist/models/LDAPProvider.js

@@ -27,7 +27,7 @@ function LDAPProviderFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'pk': json['pk'],
         'name': json['name'],
-        'authorizationFlow': json['authorization_flow'],
+        'authorizationFlow': !(0, runtime_1.exists)(json, 'authorization_flow') ? undefined : json['authorization_flow'],
         'propertyMappings': !(0, runtime_1.exists)(json, 'property_mappings') ? undefined : json['property_mappings'],
         'component': json['component'],
         'assignedApplicationSlug': json['assigned_application_slug'],

package/dist/models/LDAPProviderRequest.d.ts

@@ -27,7 +27,7 @@ export interface LDAPProviderRequest {
      * @type {string}
      * @memberof LDAPProviderRequest
      */
-    authorizationFlow: string;
+    authorizationFlow?: string | null;
     /**
      *
      * @type {Array<string>}

package/dist/models/LDAPProviderRequest.js

@@ -26,7 +26,7 @@ function LDAPProviderRequestFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'name': json['name'],
-        'authorizationFlow': json['authorization_flow'],
+        'authorizationFlow': !(0, runtime_1.exists)(json, 'authorization_flow') ? undefined : json['authorization_flow'],
         'propertyMappings': !(0, runtime_1.exists)(json, 'property_mappings') ? undefined : json['property_mappings'],
         'baseDn': !(0, runtime_1.exists)(json, 'base_dn') ? undefined : json['base_dn'],
         'searchGroup': !(0, runtime_1.exists)(json, 'search_group') ? undefined : json['search_group'],