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

    open class func flowsBindingsCreate(flowStageBindingRequest: FlowStageBindingRequest, completion: @escaping (_ data: FlowStageBinding?, _ error: Error?) -> Void)

FlowStageBinding Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let flowStageBindingRequest = FlowStageBindingRequest(target: 123, stage: 123, evaluateOnPlan: false, reEvaluatePolicies: false, order: 123, policyEngineMode: PolicyEngineMode(), invalidResponseAction: InvalidResponseActionEnum()) // FlowStageBindingRequest | 

FlowsAPI.flowsBindingsCreate(flowStageBindingRequest: flowStageBindingRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

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

    open class func flowsBindingsDestroy(fsbUuid: UUID, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

FlowStageBinding Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let fsbUuid = 987 // UUID | A UUID string identifying this Flow Stage Binding.

FlowsAPI.flowsBindingsDestroy(fsbUuid: fsbUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
fsbUuid	UUID	A UUID string identifying this Flow Stage Binding.

Return type

Void (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

    open class func flowsBindingsList(evaluateOnPlan: Bool? = nil, fsbUuid: UUID? = nil, invalidResponseAction: InvalidResponseAction_flowsBindingsList? = nil, order: Int? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, pbmUuid: UUID? = nil, policies: [UUID]? = nil, policyEngineMode: PolicyEngineMode_flowsBindingsList? = nil, reEvaluatePolicies: Bool? = nil, search: String? = nil, stage: UUID? = nil, target: UUID? = nil, completion: @escaping (_ data: PaginatedFlowStageBindingList?, _ error: Error?) -> Void)

FlowStageBinding Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let evaluateOnPlan = true // Bool |  (optional)
let fsbUuid = 987 // UUID |  (optional)
let 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.  * `retry` - Retry * `restart` - Restart * `restart_with_context` - Restart With Context (optional)
let order = 987 // Int |  (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let page = 987 // Int | A page number within the paginated result set. (optional)
let pageSize = 987 // Int | Number of results to return per page. (optional)
let pbmUuid = 987 // UUID |  (optional)
let policies = [123] // [UUID] |  (optional)
let policyEngineMode = "policyEngineMode_example" // String | * `all` - all, all policies must pass * `any` - any, any policy must pass (optional)
let reEvaluatePolicies = true // Bool |  (optional)
let search = "search_example" // String | A search term. (optional)
let stage = 987 // UUID |  (optional)
let target = 987 // UUID |  (optional)

FlowsAPI.flowsBindingsList(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) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
evaluateOnPlan	Bool		[optional]
fsbUuid	UUID		[optional]
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. * `retry` - Retry * `restart` - Restart * `restart_with_context` - Restart With Context	[optional]
order	Int		[optional]
ordering	String	Which field to use when ordering the results.	[optional]
page	Int	A page number within the paginated result set.	[optional]
pageSize	Int	Number of results to return per page.	[optional]
pbmUuid	UUID		[optional]
policies	[UUID]		[optional]
policyEngineMode	String	* `all` - all, all policies must pass * `any` - any, any policy must pass	[optional]
reEvaluatePolicies	Bool		[optional]
search	String	A search term.	[optional]
stage	UUID		[optional]
target	UUID		[optional]

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

    open class func flowsBindingsPartialUpdate(fsbUuid: UUID, patchedFlowStageBindingRequest: PatchedFlowStageBindingRequest? = nil, completion: @escaping (_ data: FlowStageBinding?, _ error: Error?) -> Void)

FlowStageBinding Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let fsbUuid = 987 // UUID | A UUID string identifying this Flow Stage Binding.
let patchedFlowStageBindingRequest = PatchedFlowStageBindingRequest(target: 123, stage: 123, evaluateOnPlan: false, reEvaluatePolicies: false, order: 123, policyEngineMode: PolicyEngineMode(), invalidResponseAction: InvalidResponseActionEnum()) // PatchedFlowStageBindingRequest |  (optional)

FlowsAPI.flowsBindingsPartialUpdate(fsbUuid: fsbUuid, patchedFlowStageBindingRequest: patchedFlowStageBindingRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
fsbUuid	UUID	A UUID string identifying this Flow Stage Binding.
patchedFlowStageBindingRequest	PatchedFlowStageBindingRequest		[optional]

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

    open class func flowsBindingsRetrieve(fsbUuid: UUID, completion: @escaping (_ data: FlowStageBinding?, _ error: Error?) -> Void)

FlowStageBinding Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let fsbUuid = 987 // UUID | A UUID string identifying this Flow Stage Binding.

FlowsAPI.flowsBindingsRetrieve(fsbUuid: fsbUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
fsbUuid	UUID	A UUID string identifying this Flow Stage Binding.

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

    open class func flowsBindingsUpdate(fsbUuid: UUID, flowStageBindingRequest: FlowStageBindingRequest, completion: @escaping (_ data: FlowStageBinding?, _ error: Error?) -> Void)

FlowStageBinding Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let fsbUuid = 987 // UUID | A UUID string identifying this Flow Stage Binding.
let flowStageBindingRequest = FlowStageBindingRequest(target: 123, stage: 123, evaluateOnPlan: false, reEvaluatePolicies: false, order: 123, policyEngineMode: PolicyEngineMode(), invalidResponseAction: InvalidResponseActionEnum()) // FlowStageBindingRequest | 

FlowsAPI.flowsBindingsUpdate(fsbUuid: fsbUuid, flowStageBindingRequest: flowStageBindingRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
fsbUuid	UUID	A UUID string identifying this Flow Stage Binding.
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

    open class func flowsBindingsUsedByList(fsbUuid: UUID, completion: @escaping (_ data: [UsedBy]?, _ error: Error?) -> Void)

Get a list of all objects that use this object

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let fsbUuid = 987 // UUID | A UUID string identifying this Flow Stage Binding.

FlowsAPI.flowsBindingsUsedByList(fsbUuid: fsbUuid) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
fsbUuid	UUID	A UUID string identifying this Flow Stage Binding.

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

    open class func flowsExecutorGet(flowSlug: String, query: String, completion: @escaping (_ data: ChallengeTypes?, _ error: Error?) -> Void)

Get the next pending challenge from the currently active flow.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let flowSlug = "flowSlug_example" // String | 
let query = "query_example" // String | Querystring as received

FlowsAPI.flowsExecutorGet(flowSlug: flowSlug, query: query) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
flowSlug	String
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

    open class func flowsExecutorSolve(flowSlug: String, query: String, flowChallengeResponseRequest: FlowChallengeResponseRequest? = nil, completion: @escaping (_ data: ChallengeTypes?, _ error: Error?) -> Void)

Solve the previously retrieved challenge and advanced to the next stage.

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let flowSlug = "flowSlug_example" // String | 
let query = "query_example" // String | Querystring as received
let flowChallengeResponseRequest = FlowChallengeResponseRequest(component: "component_example", code: 123, phoneNumber: "phoneNumber_example", selectedChallenge: DeviceChallengeRequest(deviceClass: "deviceClass_example", deviceUid: "deviceUid_example", challenge: "TODO"), selectedStage: "selectedStage_example", webauthn: "TODO", duo: 123, mobile: "mobile_example", response: "TODO", token: "token_example", uidField: "uidField_example", password: "password_example", rememberMe: false) // FlowChallengeResponseRequest |  (optional)

FlowsAPI.flowsExecutorSolve(flowSlug: flowSlug, query: query, flowChallengeResponseRequest: flowChallengeResponseRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
flowSlug	String
query	String	Querystring as received
flowChallengeResponseRequest	FlowChallengeResponseRequest		[optional]

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

    open class func flowsInspectorGet(flowSlug: String, completion: @escaping (_ data: FlowInspection?, _ error: Error?) -> Void)

Get current flow state and record it

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let flowSlug = "flowSlug_example" // String | 

FlowsAPI.flowsInspectorGet(flowSlug: flowSlug) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
flowSlug	String

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

    open class func flowsInstancesCacheClearCreate(completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

Clear flow cache

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient


FlowsAPI.flowsInstancesCacheClearCreate() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

Void (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

    open class func flowsInstancesCacheInfoRetrieve(completion: @escaping (_ data: Cache?, _ error: Error?) -> Void)

Info about cached flows

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient


FlowsAPI.flowsInstancesCacheInfoRetrieve() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

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

    open class func flowsInstancesCreate(flowRequest: FlowRequest, completion: @escaping (_ data: Flow?, _ error: Error?) -> Void)

Flow Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let flowRequest = FlowRequest(name: "name_example", slug: "slug_example", title: "title_example", designation: FlowDesignationEnum(), policyEngineMode: PolicyEngineMode(), compatibilityMode: false, layout: FlowLayoutEnum(), deniedAction: DeniedActionEnum(), authentication: AuthenticationEnum()) // FlowRequest | 

FlowsAPI.flowsInstancesCreate(flowRequest: flowRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

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

    open class func flowsInstancesDestroy(slug: String, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

Flow Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let slug = "slug_example" // String | 

FlowsAPI.flowsInstancesDestroy(slug: slug) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
slug	String

Return type

Void (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

    open class func flowsInstancesDiagramRetrieve(slug: String, completion: @escaping (_ data: FlowDiagram?, _ error: Error?) -> Void)

Return diagram for flow with slug slug, in the format used by flowchart.js

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let slug = "slug_example" // String | 

FlowsAPI.flowsInstancesDiagramRetrieve(slug: slug) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
slug	String

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

    open class func flowsInstancesExecuteRetrieve(slug: String, completion: @escaping (_ data: Link?, _ error: Error?) -> Void)

Execute flow for current user

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let slug = "slug_example" // String | 

FlowsAPI.flowsInstancesExecuteRetrieve(slug: slug) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
slug	String

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

    open class func flowsInstancesExportRetrieve(slug: String, completion: @escaping (_ data: URL?, _ error: Error?) -> Void)

Export flow to .yaml file

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let slug = "slug_example" // String | 

FlowsAPI.flowsInstancesExportRetrieve(slug: slug) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
slug	String

Return type

URL

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

    open class func flowsInstancesImportCreate(file: URL? = nil, clear: Bool? = nil, completion: @escaping (_ data: FlowImportResult?, _ error: Error?) -> Void)

Import flow from .yaml file

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let file = URL(string: "https://example.com")! // URL |  (optional)
let clear = true // Bool |  (optional) (default to false)

FlowsAPI.flowsInstancesImportCreate(file: file, clear: clear) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
file	URL		[optional]
clear	Bool		[optional] [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

    open class func flowsInstancesList(deniedAction: DeniedAction_flowsInstancesList? = nil, designation: Designation_flowsInstancesList? = nil, flowUuid: UUID? = nil, name: String? = nil, ordering: String? = nil, page: Int? = nil, pageSize: Int? = nil, search: String? = nil, slug: String? = nil, completion: @escaping (_ data: PaginatedFlowList?, _ error: Error?) -> Void)

Flow Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let deniedAction = "deniedAction_example" // String | Configure what should happen when a flow denies access to a user.  * `message_continue` - Message Continue * `message` - Message * `continue` - Continue (optional)
let 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.  * `authentication` - Authentication * `authorization` - Authorization * `invalidation` - Invalidation * `enrollment` - Enrollment * `unenrollment` - Unrenollment * `recovery` - Recovery * `stage_configuration` - Stage Configuration (optional)
let flowUuid = 987 // UUID |  (optional)
let name = "name_example" // String |  (optional)
let ordering = "ordering_example" // String | Which field to use when ordering the results. (optional)
let page = 987 // Int | A page number within the paginated result set. (optional)
let pageSize = 987 // Int | Number of results to return per page. (optional)
let search = "search_example" // String | A search term. (optional)
let slug = "slug_example" // String |  (optional)

FlowsAPI.flowsInstancesList(deniedAction: deniedAction, designation: designation, flowUuid: flowUuid, name: name, ordering: ordering, page: page, pageSize: pageSize, search: search, slug: slug) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
deniedAction	String	Configure what should happen when a flow denies access to a user. * `message_continue` - Message Continue * `message` - Message * `continue` - Continue	[optional]
designation	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	[optional]
flowUuid	UUID		[optional]
name	String		[optional]
ordering	String	Which field to use when ordering the results.	[optional]
page	Int	A page number within the paginated result set.	[optional]
pageSize	Int	Number of results to return per page.	[optional]
search	String	A search term.	[optional]
slug	String		[optional]

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

    open class func flowsInstancesPartialUpdate(slug: String, patchedFlowRequest: PatchedFlowRequest? = nil, completion: @escaping (_ data: Flow?, _ error: Error?) -> Void)

Flow Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let slug = "slug_example" // String | 
let patchedFlowRequest = PatchedFlowRequest(name: "name_example", slug: "slug_example", title: "title_example", designation: FlowDesignationEnum(), policyEngineMode: PolicyEngineMode(), compatibilityMode: false, layout: FlowLayoutEnum(), deniedAction: DeniedActionEnum(), authentication: AuthenticationEnum()) // PatchedFlowRequest |  (optional)

FlowsAPI.flowsInstancesPartialUpdate(slug: slug, patchedFlowRequest: patchedFlowRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
slug	String
patchedFlowRequest	PatchedFlowRequest		[optional]

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

    open class func flowsInstancesRetrieve(slug: String, completion: @escaping (_ data: Flow?, _ error: Error?) -> Void)

Flow Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let slug = "slug_example" // String | 

FlowsAPI.flowsInstancesRetrieve(slug: slug) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
slug	String

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

    open class func flowsInstancesSetBackgroundCreate(slug: String, file: URL? = nil, clear: Bool? = nil, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

Set Flow background

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let slug = "slug_example" // String | 
let file = URL(string: "https://example.com")! // URL |  (optional)
let clear = true // Bool |  (optional) (default to false)

FlowsAPI.flowsInstancesSetBackgroundCreate(slug: slug, file: file, clear: clear) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
slug	String
file	URL		[optional]
clear	Bool		[optional] [default to false]

Return type

Void (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

    open class func flowsInstancesSetBackgroundUrlCreate(slug: String, filePathRequest: FilePathRequest, completion: @escaping (_ data: Void?, _ error: Error?) -> Void)

Set Flow background (as URL)

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let slug = "slug_example" // String | 
let filePathRequest = FilePathRequest(url: "url_example") // FilePathRequest | 

FlowsAPI.flowsInstancesSetBackgroundUrlCreate(slug: slug, filePathRequest: filePathRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
slug	String
filePathRequest	FilePathRequest

Return type

Void (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

    open class func flowsInstancesUpdate(slug: String, flowRequest: FlowRequest, completion: @escaping (_ data: Flow?, _ error: Error?) -> Void)

Flow Viewset

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let slug = "slug_example" // String | 
let flowRequest = FlowRequest(name: "name_example", slug: "slug_example", title: "title_example", designation: FlowDesignationEnum(), policyEngineMode: PolicyEngineMode(), compatibilityMode: false, layout: FlowLayoutEnum(), deniedAction: DeniedActionEnum(), authentication: AuthenticationEnum()) // FlowRequest | 

FlowsAPI.flowsInstancesUpdate(slug: slug, flowRequest: flowRequest) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
slug	String
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

    open class func flowsInstancesUsedByList(slug: String, completion: @escaping (_ data: [UsedBy]?, _ error: Error?) -> Void)

Get a list of all objects that use this object

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import authentikClient

let slug = "slug_example" // String | 

FlowsAPI.flowsInstancesUsedByList(slug: slug) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name	Type	Description	Notes
slug	String

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]