Skip to main content

flows_bindings_partial_update

PATCH 
/api/v3//flows/bindings/:fsb_uuid/

FlowStageBinding Viewset

Request​

Path Parameters

    fsb_uuid uuidrequired

    A UUID string identifying this Flow Stage Binding.

Body

    targetuuid
    stageuuid
    evaluate_on_planboolean

    Evaluate policies during the Flow planning process.

    re_evaluate_policiesboolean

    Evaluate policies when the Stage is presented to the user.

    orderinteger

    Possible values: >= -2147483648 and <= 2147483647

    policy_engine_modePolicyEngineMode (string)

    Possible values: [all, any]

    invalid_response_actionInvalidResponseActionEnum (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.

    Possible values: [retry, restart, restart_with_context]

Responses​

Schema
    pkuuidrequired
    policybindingmodel_ptr_iduuidrequired
    targetuuidrequired
    stageuuidrequired
    stage_obj object

    Stage Serializer

    pkuuidrequired
    namestringrequired
    componentstringrequired

    Get object type so that we know how to edit the object

    verbose_namestringrequired

    Return object's verbose_name

    verbose_name_pluralstringrequired

    Return object's plural verbose_name

    meta_model_namestringrequired

    Return internal model name

    flow_set object[]
  • Array [
    • pkuuidrequired
    policybindingmodel_ptr_iduuidrequired
    namestringrequired
    slugstringrequired

    Visible in the URL.

    Possible values: <= 50 characters, Value must match regular expression ^[-a-zA-Z0-9_]+$

    titlestringrequired

    Shown as the Title in Flow pages.

    designationFlowDesignationEnum (string)required

    Decides what this Flow is used for. For example, the Authentication flow is redirect to when an un-authenticated user visits authentik.

    Possible values: [authentication, authorization, invalidation, enrollment, unenrollment, recovery, stage_configuration]

    backgroundstringrequired

    Get the URL to the background image. If the name is /static or starts with http it is returned as-is

    policy_engine_modePolicyEngineMode (string)

    Possible values: [all, any]

    compatibility_modeboolean

    Enable compatibility mode, increases compatibility with password managers on mobile devices.

    export_urlstringrequired

    Get export URL for flow

    layoutFlowLayoutEnum (string)

    Possible values: [stacked, content_left, content_right, sidebar_left, sidebar_right]

    denied_actionDeniedActionEnum (string)

    Configure what should happen when a flow denies access to a user.

    Possible values: [message_continue, message, continue]

  • ]
    • evaluate_on_planboolean

    Evaluate policies during the Flow planning process.

    re_evaluate_policiesboolean

    Evaluate policies when the Stage is presented to the user.

    orderintegerrequired

    Possible values: >= -2147483648 and <= 2147483647

    policy_engine_modePolicyEngineMode (string)

    Possible values: [all, any]

    invalid_response_actionInvalidResponseActionEnum (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.

    Possible values: [retry, restart, restart_with_context]

Authorization: http

name: authentiktype: httpscheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "/api/v3/flows/bindings/:fsb_uuid/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n  \"target\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"stage\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n  \"evaluate_on_plan\": true,\n  \"re_evaluate_policies\": true,\n  \"order\": 0,\n  \"policy_engine_mode\": \"all\",\n  \"invalid_response_action\": \"retry\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
/api/v3
Auth
Parameters
— pathrequired
Body
{
  "target": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "stage": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "evaluate_on_plan": true,
  "re_evaluate_policies": true,
  "order": 0,
  "policy_engine_mode": "all",
  "invalid_response_action": "retry"
}