flows_inspector_get

GET 
/api/v3//flows/inspector/:flow_slug/

Get current flow state and record it

Request

Path Parameters

flow_slug stringrequired

Responses

200

application/json

Schema

Schema

plans object[]required
Array [
current_stage object
FlowStageBinding Serializer
pkuuidrequired
policybindingmodel_ptr_iduuidrequired
targetuuidrequired
stageuuidrequired
stage_obj objectrequired
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]
next_planned_stage object
FlowStageBinding Serializer
pkuuidrequired
policybindingmodel_ptr_iduuidrequired
targetuuidrequired
stageuuidrequired
stage_obj objectrequired
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]
plan_context objectrequired
Get the plan's context, sanitized
property name*any
Get the plan's context, sanitized
session_idstringrequired
Get a unique session ID
]
current_plan object
Serializer for an active FlowPlan
current_stage object
FlowStageBinding Serializer
pkuuidrequired
policybindingmodel_ptr_iduuidrequired
targetuuidrequired
stageuuidrequired
stage_obj objectrequired
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]
next_planned_stage object
FlowStageBinding Serializer
pkuuidrequired
policybindingmodel_ptr_iduuidrequired
targetuuidrequired
stageuuidrequired
stage_obj objectrequired
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]
plan_context objectrequired
Get the plan's context, sanitized
property name*any
Get the plan's context, sanitized
session_idstringrequired
Get a unique session ID
is_completedbooleanrequired

Example (auto)

{
  "plans": [
    {
      "current_stage": {
        "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "policybindingmodel_ptr_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "target": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "stage": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "stage_obj": {
          "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string",
          "component": "string",
          "verbose_name": "string",
          "verbose_name_plural": "string",
          "meta_model_name": "string",
          "flow_set": [
            {
              "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "policybindingmodel_ptr_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "name": "string",
              "slug": "string",
              "title": "string",
              "designation": "authentication",
              "background": "string",
              "policy_engine_mode": "all",
              "compatibility_mode": true,
              "export_url": "string",
              "layout": "stacked",
              "denied_action": "message_continue"
            }
          ]
        },
        "evaluate_on_plan": true,
        "re_evaluate_policies": true,
        "order": 0,
        "policy_engine_mode": "all",
        "invalid_response_action": "retry"
      },
      "next_planned_stage": {
        "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "policybindingmodel_ptr_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "target": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "stage": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "stage_obj": {
          "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string",
          "component": "string",
          "verbose_name": "string",
          "verbose_name_plural": "string",
          "meta_model_name": "string",
          "flow_set": [
            {
              "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "policybindingmodel_ptr_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "name": "string",
              "slug": "string",
              "title": "string",
              "designation": "authentication",
              "background": "string",
              "policy_engine_mode": "all",
              "compatibility_mode": true,
              "export_url": "string",
              "layout": "stacked",
              "denied_action": "message_continue"
            }
          ]
        },
        "evaluate_on_plan": true,
        "re_evaluate_policies": true,
        "order": 0,
        "policy_engine_mode": "all",
        "invalid_response_action": "retry"
      },
      "plan_context": {},
      "session_id": "string"
    }
  ],
  "current_plan": {
    "current_stage": {
      "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "policybindingmodel_ptr_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "target": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "stage": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "stage_obj": {
        "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "component": "string",
        "verbose_name": "string",
        "verbose_name_plural": "string",
        "meta_model_name": "string",
        "flow_set": [
          {
            "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "policybindingmodel_ptr_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "name": "string",
            "slug": "string",
            "title": "string",
            "designation": "authentication",
            "background": "string",
            "policy_engine_mode": "all",
            "compatibility_mode": true,
            "export_url": "string",
            "layout": "stacked",
            "denied_action": "message_continue"
          }
        ]
      },
      "evaluate_on_plan": true,
      "re_evaluate_policies": true,
      "order": 0,
      "policy_engine_mode": "all",
      "invalid_response_action": "retry"
    },
    "next_planned_stage": {
      "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "policybindingmodel_ptr_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "target": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "stage": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "stage_obj": {
        "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "component": "string",
        "verbose_name": "string",
        "verbose_name_plural": "string",
        "meta_model_name": "string",
        "flow_set": [
          {
            "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "policybindingmodel_ptr_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "name": "string",
            "slug": "string",
            "title": "string",
            "designation": "authentication",
            "background": "string",
            "policy_engine_mode": "all",
            "compatibility_mode": true,
            "export_url": "string",
            "layout": "stacked",
            "denied_action": "message_continue"
          }
        ]
      },
      "evaluate_on_plan": true,
      "re_evaluate_policies": true,
      "order": 0,
      "policy_engine_mode": "all",
      "invalid_response_action": "retry"
    },
    "plan_context": {},
    "session_id": "string"
  },
  "is_completed": true
}

400

No flow plan in session.

403

application/json

Schema

Schema

detailstringrequired
codestring

Example (auto)

{
  "detail": "string",
  "code": "string"
}

Authorization: http

name: authentiktype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "/api/v3/flows/inspector/:flow_slug/");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

/api/v3

Auth

Bearer Token

Parameters

flow_slug — pathrequired