FlowsApi.md

\FlowsApi

All URIs are relative to http://localhost/api/v3

Method	HTTP request	Description
FlowsBindingsCreate	Post /flows/bindings/
FlowsBindingsDestroy	Delete /flows/bindings/{fsb_uuid}/
FlowsBindingsList	Get /flows/bindings/
FlowsBindingsPartialUpdate	Patch /flows/bindings/{fsb_uuid}/
FlowsBindingsRetrieve	Get /flows/bindings/{fsb_uuid}/
FlowsBindingsUpdate	Put /flows/bindings/{fsb_uuid}/
FlowsBindingsUsedByList	Get /flows/bindings/{fsb_uuid}/used_by/
FlowsExecutorGet	Get /flows/executor/{flow_slug}/
FlowsExecutorSolve	Post /flows/executor/{flow_slug}/
FlowsInspectorGet	Get /flows/inspector/{flow_slug}/
FlowsInstancesCacheClearCreate	Post /flows/instances/cache_clear/
FlowsInstancesCacheInfoRetrieve	Get /flows/instances/cache_info/
FlowsInstancesCreate	Post /flows/instances/
FlowsInstancesDestroy	Delete /flows/instances/{slug}/
FlowsInstancesDiagramRetrieve	Get /flows/instances/{slug}/diagram/
FlowsInstancesExecuteRetrieve	Get /flows/instances/{slug}/execute/
FlowsInstancesExportRetrieve	Get /flows/instances/{slug}/export/
FlowsInstancesImportCreate	Post /flows/instances/import/
FlowsInstancesList	Get /flows/instances/
FlowsInstancesPartialUpdate	Patch /flows/instances/{slug}/
FlowsInstancesRetrieve	Get /flows/instances/{slug}/
FlowsInstancesSetBackgroundCreate	Post /flows/instances/{slug}/set_background/
FlowsInstancesSetBackgroundUrlCreate	Post /flows/instances/{slug}/set_background_url/
FlowsInstancesUpdate	Put /flows/instances/{slug}/
FlowsInstancesUsedByList	Get /flows/instances/{slug}/used_by/

FlowsBindingsCreate

FlowStageBinding FlowsBindingsCreate(ctx).FlowStageBindingRequest(flowStageBindingRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    flowStageBindingRequest := *openapiclient.NewFlowStageBindingRequest("Target_example", "Stage_example", int32(123)) // FlowStageBindingRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FlowsApi.FlowsBindingsCreate(context.Background()).FlowStageBindingRequest(flowStageBindingRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FlowsApi.FlowsBindingsCreate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `FlowsBindingsCreate`: FlowStageBinding
    fmt.Fprintf(os.Stdout, "Response from `FlowsApi.FlowsBindingsCreate`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiFlowsBindingsCreateRequest struct via the builder pattern

Name	Type	Description	Notes
flowStageBindingRequest	FlowStageBindingRequest

Return type

FlowStageBinding

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FlowsBindingsDestroy

FlowsBindingsDestroy(ctx, fsbUuid).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    fsbUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Flow Stage Binding.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FlowsApi.FlowsBindingsDestroy(context.Background(), fsbUuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FlowsApi.FlowsBindingsDestroy``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
fsbUuid	string	A UUID string identifying this Flow Stage Binding.

Other Parameters

Other parameters are passed through a pointer to a apiFlowsBindingsDestroyRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FlowsBindingsList

PaginatedFlowStageBindingList FlowsBindingsList(ctx).EvaluateOnPlan(evaluateOnPlan).FsbUuid(fsbUuid).InvalidResponseAction(invalidResponseAction).Order(order).Ordering(ordering).Page(page).PageSize(pageSize).PbmUuid(pbmUuid).Policies(policies).PolicyEngineMode(policyEngineMode).ReEvaluatePolicies(reEvaluatePolicies).Search(search).Stage(stage).Target(target).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    evaluateOnPlan := true // bool |  (optional)
    fsbUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
    invalidResponseAction := "invalidResponseAction_example" // string | 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.   (optional)
    order := int32(56) // int32 |  (optional)
    ordering := "ordering_example" // string | Which field to use when ordering the results. (optional)
    page := int32(56) // int32 | A page number within the paginated result set. (optional)
    pageSize := int32(56) // int32 | Number of results to return per page. (optional)
    pbmUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
    policies := []string{"Inner_example"} // []string |  (optional)
    policyEngineMode := "policyEngineMode_example" // string |  (optional)
    reEvaluatePolicies := true // bool |  (optional)
    search := "search_example" // string | A search term. (optional)
    stage := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
    target := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FlowsApi.FlowsBindingsList(context.Background()).EvaluateOnPlan(evaluateOnPlan).FsbUuid(fsbUuid).InvalidResponseAction(invalidResponseAction).Order(order).Ordering(ordering).Page(page).PageSize(pageSize).PbmUuid(pbmUuid).Policies(policies).PolicyEngineMode(policyEngineMode).ReEvaluatePolicies(reEvaluatePolicies).Search(search).Stage(stage).Target(target).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FlowsApi.FlowsBindingsList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `FlowsBindingsList`: PaginatedFlowStageBindingList
    fmt.Fprintf(os.Stdout, "Response from `FlowsApi.FlowsBindingsList`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiFlowsBindingsListRequest struct via the builder pattern

Name	Type	Description	Notes
evaluateOnPlan	bool
fsbUuid	string
invalidResponseAction	string	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.
order	int32
ordering	string	Which field to use when ordering the results.
page	int32	A page number within the paginated result set.
pageSize	int32	Number of results to return per page.
pbmUuid	string
policies	[]string
policyEngineMode	string
reEvaluatePolicies	bool
search	string	A search term.
stage	string
target	string

Return type

PaginatedFlowStageBindingList

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FlowsBindingsPartialUpdate

FlowStageBinding FlowsBindingsPartialUpdate(ctx, fsbUuid).PatchedFlowStageBindingRequest(patchedFlowStageBindingRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    fsbUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Flow Stage Binding.
    patchedFlowStageBindingRequest := *openapiclient.NewPatchedFlowStageBindingRequest() // PatchedFlowStageBindingRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FlowsApi.FlowsBindingsPartialUpdate(context.Background(), fsbUuid).PatchedFlowStageBindingRequest(patchedFlowStageBindingRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FlowsApi.FlowsBindingsPartialUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `FlowsBindingsPartialUpdate`: FlowStageBinding
    fmt.Fprintf(os.Stdout, "Response from `FlowsApi.FlowsBindingsPartialUpdate`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
fsbUuid	string	A UUID string identifying this Flow Stage Binding.

Other Parameters

Other parameters are passed through a pointer to a apiFlowsBindingsPartialUpdateRequest struct via the builder pattern

Name	Type	Description	Notes

patchedFlowStageBindingRequest | PatchedFlowStageBindingRequest | |

Return type

FlowStageBinding

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FlowsBindingsRetrieve

FlowStageBinding FlowsBindingsRetrieve(ctx, fsbUuid).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    fsbUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Flow Stage Binding.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FlowsApi.FlowsBindingsRetrieve(context.Background(), fsbUuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FlowsApi.FlowsBindingsRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `FlowsBindingsRetrieve`: FlowStageBinding
    fmt.Fprintf(os.Stdout, "Response from `FlowsApi.FlowsBindingsRetrieve`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
fsbUuid	string	A UUID string identifying this Flow Stage Binding.

Other Parameters

Other parameters are passed through a pointer to a apiFlowsBindingsRetrieveRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

FlowStageBinding

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FlowsBindingsUpdate

FlowStageBinding FlowsBindingsUpdate(ctx, fsbUuid).FlowStageBindingRequest(flowStageBindingRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    fsbUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Flow Stage Binding.
    flowStageBindingRequest := *openapiclient.NewFlowStageBindingRequest("Target_example", "Stage_example", int32(123)) // FlowStageBindingRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FlowsApi.FlowsBindingsUpdate(context.Background(), fsbUuid).FlowStageBindingRequest(flowStageBindingRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FlowsApi.FlowsBindingsUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `FlowsBindingsUpdate`: FlowStageBinding
    fmt.Fprintf(os.Stdout, "Response from `FlowsApi.FlowsBindingsUpdate`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
fsbUuid	string	A UUID string identifying this Flow Stage Binding.

Other Parameters

Other parameters are passed through a pointer to a apiFlowsBindingsUpdateRequest struct via the builder pattern

Name	Type	Description	Notes

flowStageBindingRequest | FlowStageBindingRequest | |

Return type

FlowStageBinding

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FlowsBindingsUsedByList

[]UsedBy FlowsBindingsUsedByList(ctx, fsbUuid).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    fsbUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | A UUID string identifying this Flow Stage Binding.

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FlowsApi.FlowsBindingsUsedByList(context.Background(), fsbUuid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FlowsApi.FlowsBindingsUsedByList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `FlowsBindingsUsedByList`: []UsedBy
    fmt.Fprintf(os.Stdout, "Response from `FlowsApi.FlowsBindingsUsedByList`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
fsbUuid	string	A UUID string identifying this Flow Stage Binding.

Other Parameters

Other parameters are passed through a pointer to a apiFlowsBindingsUsedByListRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]UsedBy

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FlowsExecutorGet

ChallengeTypes FlowsExecutorGet(ctx, flowSlug).Query(query).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    flowSlug := "flowSlug_example" // string | 
    query := "query_example" // string | Querystring as received

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FlowsApi.FlowsExecutorGet(context.Background(), flowSlug).Query(query).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FlowsApi.FlowsExecutorGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `FlowsExecutorGet`: ChallengeTypes
    fmt.Fprintf(os.Stdout, "Response from `FlowsApi.FlowsExecutorGet`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
flowSlug	string

Other Parameters

Other parameters are passed through a pointer to a apiFlowsExecutorGetRequest struct via the builder pattern

Name	Type	Description	Notes

query | string | Querystring as received |

Return type

ChallengeTypes

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FlowsExecutorSolve

ChallengeTypes FlowsExecutorSolve(ctx, flowSlug).Query(query).FlowChallengeResponseRequest(flowChallengeResponseRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    flowSlug := "flowSlug_example" // string | 
    query := "query_example" // string | Querystring as received
    flowChallengeResponseRequest := openapiclient.FlowChallengeResponseRequest{AppleChallengeResponseRequest: openapiclient.NewAppleChallengeResponseRequest()} // FlowChallengeResponseRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FlowsApi.FlowsExecutorSolve(context.Background(), flowSlug).Query(query).FlowChallengeResponseRequest(flowChallengeResponseRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FlowsApi.FlowsExecutorSolve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `FlowsExecutorSolve`: ChallengeTypes
    fmt.Fprintf(os.Stdout, "Response from `FlowsApi.FlowsExecutorSolve`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
flowSlug	string

Other Parameters

Other parameters are passed through a pointer to a apiFlowsExecutorSolveRequest struct via the builder pattern

Name	Type	Description	Notes

query | string | Querystring as received | flowChallengeResponseRequest | FlowChallengeResponseRequest | |

Return type

ChallengeTypes

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FlowsInspectorGet

FlowInspection FlowsInspectorGet(ctx, flowSlug).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    flowSlug := "flowSlug_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FlowsApi.FlowsInspectorGet(context.Background(), flowSlug).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FlowsApi.FlowsInspectorGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `FlowsInspectorGet`: FlowInspection
    fmt.Fprintf(os.Stdout, "Response from `FlowsApi.FlowsInspectorGet`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
flowSlug	string

Other Parameters

Other parameters are passed through a pointer to a apiFlowsInspectorGetRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

FlowInspection

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FlowsInstancesCacheClearCreate

FlowsInstancesCacheClearCreate(ctx).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FlowsApi.FlowsInstancesCacheClearCreate(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FlowsApi.FlowsInstancesCacheClearCreate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiFlowsInstancesCacheClearCreateRequest struct via the builder pattern

Return type

(empty response body)

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FlowsInstancesCacheInfoRetrieve

Cache FlowsInstancesCacheInfoRetrieve(ctx).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FlowsApi.FlowsInstancesCacheInfoRetrieve(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FlowsApi.FlowsInstancesCacheInfoRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `FlowsInstancesCacheInfoRetrieve`: Cache
    fmt.Fprintf(os.Stdout, "Response from `FlowsApi.FlowsInstancesCacheInfoRetrieve`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiFlowsInstancesCacheInfoRetrieveRequest struct via the builder pattern

Return type

Cache

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FlowsInstancesCreate

Flow FlowsInstancesCreate(ctx).FlowRequest(flowRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    flowRequest := *openapiclient.NewFlowRequest("Name_example", "Slug_example", "Title_example", openapiclient.FlowDesignationEnum("authentication")) // FlowRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FlowsApi.FlowsInstancesCreate(context.Background()).FlowRequest(flowRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FlowsApi.FlowsInstancesCreate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `FlowsInstancesCreate`: Flow
    fmt.Fprintf(os.Stdout, "Response from `FlowsApi.FlowsInstancesCreate`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiFlowsInstancesCreateRequest struct via the builder pattern

Name	Type	Description	Notes
flowRequest	FlowRequest

Return type

Flow

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FlowsInstancesDestroy

FlowsInstancesDestroy(ctx, slug).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    slug := "slug_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FlowsApi.FlowsInstancesDestroy(context.Background(), slug).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FlowsApi.FlowsInstancesDestroy``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
slug	string

Other Parameters

Other parameters are passed through a pointer to a apiFlowsInstancesDestroyRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FlowsInstancesDiagramRetrieve

FlowDiagram FlowsInstancesDiagramRetrieve(ctx, slug).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    slug := "slug_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FlowsApi.FlowsInstancesDiagramRetrieve(context.Background(), slug).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FlowsApi.FlowsInstancesDiagramRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `FlowsInstancesDiagramRetrieve`: FlowDiagram
    fmt.Fprintf(os.Stdout, "Response from `FlowsApi.FlowsInstancesDiagramRetrieve`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
slug	string

Other Parameters

Other parameters are passed through a pointer to a apiFlowsInstancesDiagramRetrieveRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

FlowDiagram

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FlowsInstancesExecuteRetrieve

Link FlowsInstancesExecuteRetrieve(ctx, slug).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    slug := "slug_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FlowsApi.FlowsInstancesExecuteRetrieve(context.Background(), slug).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FlowsApi.FlowsInstancesExecuteRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `FlowsInstancesExecuteRetrieve`: Link
    fmt.Fprintf(os.Stdout, "Response from `FlowsApi.FlowsInstancesExecuteRetrieve`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
slug	string

Other Parameters

Other parameters are passed through a pointer to a apiFlowsInstancesExecuteRetrieveRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

Link

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FlowsInstancesExportRetrieve

*os.File FlowsInstancesExportRetrieve(ctx, slug).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    slug := "slug_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FlowsApi.FlowsInstancesExportRetrieve(context.Background(), slug).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FlowsApi.FlowsInstancesExportRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `FlowsInstancesExportRetrieve`: *os.File
    fmt.Fprintf(os.Stdout, "Response from `FlowsApi.FlowsInstancesExportRetrieve`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
slug	string

Other Parameters

Other parameters are passed through a pointer to a apiFlowsInstancesExportRetrieveRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

*os.File

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FlowsInstancesImportCreate

FlowImportResult FlowsInstancesImportCreate(ctx).File(file).Clear(clear).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    file := os.NewFile(1234, "some_file") // *os.File |  (optional)
    clear := true // bool |  (optional) (default to false)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FlowsApi.FlowsInstancesImportCreate(context.Background()).File(file).Clear(clear).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FlowsApi.FlowsInstancesImportCreate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `FlowsInstancesImportCreate`: FlowImportResult
    fmt.Fprintf(os.Stdout, "Response from `FlowsApi.FlowsInstancesImportCreate`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiFlowsInstancesImportCreateRequest struct via the builder pattern

Name	Type	Description	Notes
file	*os.File
clear	bool		[default to false]

Return type

FlowImportResult

Authorization

authentik

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FlowsInstancesList

PaginatedFlowList FlowsInstancesList(ctx).DeniedAction(deniedAction).Designation(designation).FlowUuid(flowUuid).Name(name).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Slug(slug).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    deniedAction := "deniedAction_example" // string | Configure what should happen when a flow denies access to a user.   (optional)
    designation := "designation_example" // string | Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.   (optional)
    flowUuid := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string |  (optional)
    name := "name_example" // string |  (optional)
    ordering := "ordering_example" // string | Which field to use when ordering the results. (optional)
    page := int32(56) // int32 | A page number within the paginated result set. (optional)
    pageSize := int32(56) // int32 | Number of results to return per page. (optional)
    search := "search_example" // string | A search term. (optional)
    slug := "slug_example" // string |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FlowsApi.FlowsInstancesList(context.Background()).DeniedAction(deniedAction).Designation(designation).FlowUuid(flowUuid).Name(name).Ordering(ordering).Page(page).PageSize(pageSize).Search(search).Slug(slug).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FlowsApi.FlowsInstancesList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `FlowsInstancesList`: PaginatedFlowList
    fmt.Fprintf(os.Stdout, "Response from `FlowsApi.FlowsInstancesList`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiFlowsInstancesListRequest struct via the builder pattern

Name	Type	Description	Notes
deniedAction	string	Configure what should happen when a flow denies access to a user.
designation	string	Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.
flowUuid	string
name	string
ordering	string	Which field to use when ordering the results.
page	int32	A page number within the paginated result set.
pageSize	int32	Number of results to return per page.
search	string	A search term.
slug	string

Return type

PaginatedFlowList

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FlowsInstancesPartialUpdate

Flow FlowsInstancesPartialUpdate(ctx, slug).PatchedFlowRequest(patchedFlowRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    slug := "slug_example" // string | 
    patchedFlowRequest := *openapiclient.NewPatchedFlowRequest() // PatchedFlowRequest |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FlowsApi.FlowsInstancesPartialUpdate(context.Background(), slug).PatchedFlowRequest(patchedFlowRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FlowsApi.FlowsInstancesPartialUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `FlowsInstancesPartialUpdate`: Flow
    fmt.Fprintf(os.Stdout, "Response from `FlowsApi.FlowsInstancesPartialUpdate`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
slug	string

Other Parameters

Other parameters are passed through a pointer to a apiFlowsInstancesPartialUpdateRequest struct via the builder pattern

Name	Type	Description	Notes

patchedFlowRequest | PatchedFlowRequest | |

Return type

Flow

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FlowsInstancesRetrieve

Flow FlowsInstancesRetrieve(ctx, slug).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    slug := "slug_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FlowsApi.FlowsInstancesRetrieve(context.Background(), slug).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FlowsApi.FlowsInstancesRetrieve``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `FlowsInstancesRetrieve`: Flow
    fmt.Fprintf(os.Stdout, "Response from `FlowsApi.FlowsInstancesRetrieve`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
slug	string

Other Parameters

Other parameters are passed through a pointer to a apiFlowsInstancesRetrieveRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

Flow

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FlowsInstancesSetBackgroundCreate

FlowsInstancesSetBackgroundCreate(ctx, slug).File(file).Clear(clear).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    slug := "slug_example" // string | 
    file := os.NewFile(1234, "some_file") // *os.File |  (optional)
    clear := true // bool |  (optional) (default to false)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FlowsApi.FlowsInstancesSetBackgroundCreate(context.Background(), slug).File(file).Clear(clear).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FlowsApi.FlowsInstancesSetBackgroundCreate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
slug	string

Other Parameters

Other parameters are passed through a pointer to a apiFlowsInstancesSetBackgroundCreateRequest struct via the builder pattern

Name	Type	Description	Notes

file | *os.File | | clear | bool | | [default to false]

Return type

(empty response body)

Authorization

authentik

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FlowsInstancesSetBackgroundUrlCreate

FlowsInstancesSetBackgroundUrlCreate(ctx, slug).FilePathRequest(filePathRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    slug := "slug_example" // string | 
    filePathRequest := *openapiclient.NewFilePathRequest("Url_example") // FilePathRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FlowsApi.FlowsInstancesSetBackgroundUrlCreate(context.Background(), slug).FilePathRequest(filePathRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FlowsApi.FlowsInstancesSetBackgroundUrlCreate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
slug	string

Other Parameters

Other parameters are passed through a pointer to a apiFlowsInstancesSetBackgroundUrlCreateRequest struct via the builder pattern

Name	Type	Description	Notes

filePathRequest | FilePathRequest | |

Return type

(empty response body)

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FlowsInstancesUpdate

Flow FlowsInstancesUpdate(ctx, slug).FlowRequest(flowRequest).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    slug := "slug_example" // string | 
    flowRequest := *openapiclient.NewFlowRequest("Name_example", "Slug_example", "Title_example", openapiclient.FlowDesignationEnum("authentication")) // FlowRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FlowsApi.FlowsInstancesUpdate(context.Background(), slug).FlowRequest(flowRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FlowsApi.FlowsInstancesUpdate``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `FlowsInstancesUpdate`: Flow
    fmt.Fprintf(os.Stdout, "Response from `FlowsApi.FlowsInstancesUpdate`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
slug	string

Other Parameters

Other parameters are passed through a pointer to a apiFlowsInstancesUpdateRequest struct via the builder pattern

Name	Type	Description	Notes

flowRequest | FlowRequest | |

Return type

Flow

Authorization

authentik

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FlowsInstancesUsedByList

[]UsedBy FlowsInstancesUsedByList(ctx, slug).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    slug := "slug_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.FlowsApi.FlowsInstancesUsedByList(context.Background(), slug).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `FlowsApi.FlowsInstancesUsedByList``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `FlowsInstancesUsedByList`: []UsedBy
    fmt.Fprintf(os.Stdout, "Response from `FlowsApi.FlowsInstancesUsedByList`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
slug	string

Other Parameters

Other parameters are passed through a pointer to a apiFlowsInstancesUsedByListRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]UsedBy

Authorization

authentik

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]