/** * authentik * Making authentication simple. * * The version of the OpenAPI document: 2025.6.3 * Contact: hello@goauthentik.io * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import type { Cache, ChallengeTypes, FilePathRequest, Flow, FlowChallengeResponseRequest, FlowDiagram, FlowImportResult, FlowInspection, FlowRequest, FlowStageBinding, FlowStageBindingRequest, Link, PaginatedFlowList, PaginatedFlowStageBindingList, PatchedFlowRequest, PatchedFlowStageBindingRequest, UsedBy } from '../models/index'; export interface FlowsBindingsCreateRequest { flowStageBindingRequest: FlowStageBindingRequest; } export interface FlowsBindingsDestroyRequest { fsbUuid: string; } export interface FlowsBindingsListRequest { evaluateOnPlan?: boolean; fsbUuid?: string; invalidResponseAction?: FlowsBindingsListInvalidResponseActionEnum; order?: number; ordering?: string; page?: number; pageSize?: number; pbmUuid?: string; policies?: Array; policyEngineMode?: FlowsBindingsListPolicyEngineModeEnum; reEvaluatePolicies?: boolean; search?: string; stage?: string; target?: string; } export interface FlowsBindingsPartialUpdateRequest { fsbUuid: string; patchedFlowStageBindingRequest?: PatchedFlowStageBindingRequest; } export interface FlowsBindingsRetrieveRequest { fsbUuid: string; } export interface FlowsBindingsUpdateRequest { fsbUuid: string; flowStageBindingRequest: FlowStageBindingRequest; } export interface FlowsBindingsUsedByListRequest { fsbUuid: string; } export interface FlowsExecutorGetRequest { flowSlug: string; query: string; } export interface FlowsExecutorSolveRequest { flowSlug: string; query: string; flowChallengeResponseRequest?: FlowChallengeResponseRequest; } export interface FlowsInspectorGetRequest { flowSlug: string; } export interface FlowsInstancesCreateRequest { flowRequest: FlowRequest; } export interface FlowsInstancesDestroyRequest { slug: string; } export interface FlowsInstancesDiagramRetrieveRequest { slug: string; } export interface FlowsInstancesExecuteRetrieveRequest { slug: string; } export interface FlowsInstancesExportRetrieveRequest { slug: string; } export interface FlowsInstancesImportCreateRequest { file?: Blob; clear?: boolean; } export interface FlowsInstancesListRequest { deniedAction?: FlowsInstancesListDeniedActionEnum; designation?: FlowsInstancesListDesignationEnum; flowUuid?: string; name?: string; ordering?: string; page?: number; pageSize?: number; search?: string; slug?: string; } export interface FlowsInstancesPartialUpdateRequest { slug: string; patchedFlowRequest?: PatchedFlowRequest; } export interface FlowsInstancesRetrieveRequest { slug: string; } export interface FlowsInstancesSetBackgroundCreateRequest { slug: string; file?: Blob; clear?: boolean; } export interface FlowsInstancesSetBackgroundUrlCreateRequest { slug: string; filePathRequest: FilePathRequest; } export interface FlowsInstancesUpdateRequest { slug: string; flowRequest: FlowRequest; } export interface FlowsInstancesUsedByListRequest { slug: string; } /** * */ export declare class FlowsApi extends runtime.BaseAPI { /** * FlowStageBinding Viewset */ flowsBindingsCreateRaw(requestParameters: FlowsBindingsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * FlowStageBinding Viewset */ flowsBindingsCreate(requestParameters: FlowsBindingsCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * FlowStageBinding Viewset */ flowsBindingsDestroyRaw(requestParameters: FlowsBindingsDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * FlowStageBinding Viewset */ flowsBindingsDestroy(requestParameters: FlowsBindingsDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * FlowStageBinding Viewset */ flowsBindingsListRaw(requestParameters: FlowsBindingsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * FlowStageBinding Viewset */ flowsBindingsList(requestParameters?: FlowsBindingsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * FlowStageBinding Viewset */ flowsBindingsPartialUpdateRaw(requestParameters: FlowsBindingsPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * FlowStageBinding Viewset */ flowsBindingsPartialUpdate(requestParameters: FlowsBindingsPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * FlowStageBinding Viewset */ flowsBindingsRetrieveRaw(requestParameters: FlowsBindingsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * FlowStageBinding Viewset */ flowsBindingsRetrieve(requestParameters: FlowsBindingsRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * FlowStageBinding Viewset */ flowsBindingsUpdateRaw(requestParameters: FlowsBindingsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * FlowStageBinding Viewset */ flowsBindingsUpdate(requestParameters: FlowsBindingsUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Get a list of all objects that use this object */ flowsBindingsUsedByListRaw(requestParameters: FlowsBindingsUsedByListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>>; /** * Get a list of all objects that use this object */ flowsBindingsUsedByList(requestParameters: FlowsBindingsUsedByListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get the next pending challenge from the currently active flow. */ flowsExecutorGetRaw(requestParameters: FlowsExecutorGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get the next pending challenge from the currently active flow. */ flowsExecutorGet(requestParameters: FlowsExecutorGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Solve the previously retrieved challenge and advanced to the next stage. */ flowsExecutorSolveRaw(requestParameters: FlowsExecutorSolveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Solve the previously retrieved challenge and advanced to the next stage. */ flowsExecutorSolve(requestParameters: FlowsExecutorSolveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Get current flow state and record it */ flowsInspectorGetRaw(requestParameters: FlowsInspectorGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get current flow state and record it */ flowsInspectorGet(requestParameters: FlowsInspectorGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Clear flow cache */ flowsInstancesCacheClearCreateRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Clear flow cache */ flowsInstancesCacheClearCreate(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Info about cached flows */ flowsInstancesCacheInfoRetrieveRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Info about cached flows */ flowsInstancesCacheInfoRetrieve(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Flow Viewset */ flowsInstancesCreateRaw(requestParameters: FlowsInstancesCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Flow Viewset */ flowsInstancesCreate(requestParameters: FlowsInstancesCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Flow Viewset */ flowsInstancesDestroyRaw(requestParameters: FlowsInstancesDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Flow Viewset */ flowsInstancesDestroy(requestParameters: FlowsInstancesDestroyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Return diagram for flow with slug `slug`, in the format used by flowchart.js */ flowsInstancesDiagramRetrieveRaw(requestParameters: FlowsInstancesDiagramRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Return diagram for flow with slug `slug`, in the format used by flowchart.js */ flowsInstancesDiagramRetrieve(requestParameters: FlowsInstancesDiagramRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Execute flow for current user */ flowsInstancesExecuteRetrieveRaw(requestParameters: FlowsInstancesExecuteRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Execute flow for current user */ flowsInstancesExecuteRetrieve(requestParameters: FlowsInstancesExecuteRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Export flow to .yaml file */ flowsInstancesExportRetrieveRaw(requestParameters: FlowsInstancesExportRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Export flow to .yaml file */ flowsInstancesExportRetrieve(requestParameters: FlowsInstancesExportRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Import flow from .yaml file */ flowsInstancesImportCreateRaw(requestParameters: FlowsInstancesImportCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Import flow from .yaml file */ flowsInstancesImportCreate(requestParameters?: FlowsInstancesImportCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Flow Viewset */ flowsInstancesListRaw(requestParameters: FlowsInstancesListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Flow Viewset */ flowsInstancesList(requestParameters?: FlowsInstancesListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Flow Viewset */ flowsInstancesPartialUpdateRaw(requestParameters: FlowsInstancesPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Flow Viewset */ flowsInstancesPartialUpdate(requestParameters: FlowsInstancesPartialUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Flow Viewset */ flowsInstancesRetrieveRaw(requestParameters: FlowsInstancesRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Flow Viewset */ flowsInstancesRetrieve(requestParameters: FlowsInstancesRetrieveRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Set Flow background */ flowsInstancesSetBackgroundCreateRaw(requestParameters: FlowsInstancesSetBackgroundCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Set Flow background */ flowsInstancesSetBackgroundCreate(requestParameters: FlowsInstancesSetBackgroundCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Set Flow background (as URL) */ flowsInstancesSetBackgroundUrlCreateRaw(requestParameters: FlowsInstancesSetBackgroundUrlCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Set Flow background (as URL) */ flowsInstancesSetBackgroundUrlCreate(requestParameters: FlowsInstancesSetBackgroundUrlCreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Flow Viewset */ flowsInstancesUpdateRaw(requestParameters: FlowsInstancesUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Flow Viewset */ flowsInstancesUpdate(requestParameters: FlowsInstancesUpdateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Get a list of all objects that use this object */ flowsInstancesUsedByListRaw(requestParameters: FlowsInstancesUsedByListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>>; /** * Get a list of all objects that use this object */ flowsInstancesUsedByList(requestParameters: FlowsInstancesUsedByListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; } /** * @export */ export declare const FlowsBindingsListInvalidResponseActionEnum: { readonly Restart: "restart"; readonly RestartWithContext: "restart_with_context"; readonly Retry: "retry"; readonly UnknownDefaultOpenApi: "11184809"; }; export type FlowsBindingsListInvalidResponseActionEnum = typeof FlowsBindingsListInvalidResponseActionEnum[keyof typeof FlowsBindingsListInvalidResponseActionEnum]; /** * @export */ export declare const FlowsBindingsListPolicyEngineModeEnum: { readonly All: "all"; readonly Any: "any"; readonly UnknownDefaultOpenApi: "11184809"; }; export type FlowsBindingsListPolicyEngineModeEnum = typeof FlowsBindingsListPolicyEngineModeEnum[keyof typeof FlowsBindingsListPolicyEngineModeEnum]; /** * @export */ export declare const FlowsInstancesListDeniedActionEnum: { readonly Continue: "continue"; readonly Message: "message"; readonly MessageContinue: "message_continue"; readonly UnknownDefaultOpenApi: "11184809"; }; export type FlowsInstancesListDeniedActionEnum = typeof FlowsInstancesListDeniedActionEnum[keyof typeof FlowsInstancesListDeniedActionEnum]; /** * @export */ export declare const FlowsInstancesListDesignationEnum: { readonly Authentication: "authentication"; readonly Authorization: "authorization"; readonly Enrollment: "enrollment"; readonly Invalidation: "invalidation"; readonly Recovery: "recovery"; readonly StageConfiguration: "stage_configuration"; readonly Unenrollment: "unenrollment"; readonly UnknownDefaultOpenApi: "11184809"; }; export type FlowsInstancesListDesignationEnum = typeof FlowsInstancesListDesignationEnum[keyof typeof FlowsInstancesListDesignationEnum]; //# sourceMappingURL=FlowsApi.d.ts.map