Skip to main content

flows_inspector_get

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

Get current flow state and record it

Request​

Path Parameters

    flow_slug stringrequired

Responses​

Schema

    plans

    object[]

    required

  • Array [

    • current_stage

    object

    required

    FlowStageBinding Serializer

    pk uuidrequired
    policybindingmodel_ptr_id uuidrequired
    target uuidrequired
    stage uuidrequired

    stage_obj

    object

    required

    Stage Serializer

    pk uuidrequired
    name stringrequired
    component stringrequired

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

    verbose_name stringrequired

    Return object's verbose_name

    verbose_name_plural stringrequired

    Return object's plural verbose_name

    meta_model_name stringrequired

    Return internal model name

    flow_set

    object[]

  • Array [

    • pk uuidrequired
    policybindingmodel_ptr_id uuidrequired
    name stringrequired
    slug stringrequired

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

    Visible in the URL.

    title stringrequired

    Shown as the Title in Flow pages.

    designation FlowDesignationEnum (string)required

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

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

    background stringrequired

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

    policy_engine_mode PolicyEngineMode (string)

    Possible values: [all, any]

    compatibility_mode boolean

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

    export_url stringrequired

    Get export URL for flow

    layout FlowLayoutEnum (string)

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

    denied_action DeniedActionEnum (string)

    Possible values: [message_continue, message, continue]

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

  • ]

    • evaluate_on_plan boolean

    Evaluate policies during the Flow planning process.

    re_evaluate_policies boolean

    Evaluate policies when the Stage is present to the user.

    order integerrequired

    Possible values: >= -2147483648 and <= 2147483647

    policy_engine_mode PolicyEngineMode (string)

    Possible values: [all, any]

    invalid_response_action InvalidResponseActionEnum (string)

    Possible values: [retry, restart, restart_with_context]

    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.

    next_planned_stage

    object

    required

    FlowStageBinding Serializer

    pk uuidrequired
    policybindingmodel_ptr_id uuidrequired
    target uuidrequired
    stage uuidrequired

    stage_obj

    object

    required

    Stage Serializer

    pk uuidrequired
    name stringrequired
    component stringrequired

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

    verbose_name stringrequired

    Return object's verbose_name

    verbose_name_plural stringrequired

    Return object's plural verbose_name

    meta_model_name stringrequired

    Return internal model name

    flow_set

    object[]

  • Array [

    • pk uuidrequired
    policybindingmodel_ptr_id uuidrequired
    name stringrequired
    slug stringrequired

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

    Visible in the URL.

    title stringrequired

    Shown as the Title in Flow pages.

    designation FlowDesignationEnum (string)required

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

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

    background stringrequired

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

    policy_engine_mode PolicyEngineMode (string)

    Possible values: [all, any]

    compatibility_mode boolean

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

    export_url stringrequired

    Get export URL for flow

    layout FlowLayoutEnum (string)

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

    denied_action DeniedActionEnum (string)

    Possible values: [message_continue, message, continue]

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

  • ]

    • evaluate_on_plan boolean

    Evaluate policies during the Flow planning process.

    re_evaluate_policies boolean

    Evaluate policies when the Stage is present to the user.

    order integerrequired

    Possible values: >= -2147483648 and <= 2147483647

    policy_engine_mode PolicyEngineMode (string)

    Possible values: [all, any]

    invalid_response_action InvalidResponseActionEnum (string)

    Possible values: [retry, restart, restart_with_context]

    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.

    plan_context

    object

    required

    Get the plan's context, sanitized

    property name* any

    Get the plan's context, sanitized

    session_id stringrequired

    Get a unique session ID

  • ]

    • current_plan

    object

    Serializer for an active FlowPlan

    current_stage

    object

    required

    FlowStageBinding Serializer

    pk uuidrequired
    policybindingmodel_ptr_id uuidrequired
    target uuidrequired
    stage uuidrequired

    stage_obj

    object

    required

    Stage Serializer

    pk uuidrequired
    name stringrequired
    component stringrequired

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

    verbose_name stringrequired

    Return object's verbose_name

    verbose_name_plural stringrequired

    Return object's plural verbose_name

    meta_model_name stringrequired

    Return internal model name

    flow_set

    object[]

  • Array [

    • pk uuidrequired
    policybindingmodel_ptr_id uuidrequired
    name stringrequired
    slug stringrequired

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

    Visible in the URL.

    title stringrequired

    Shown as the Title in Flow pages.

    designation FlowDesignationEnum (string)required

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

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

    background stringrequired

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

    policy_engine_mode PolicyEngineMode (string)

    Possible values: [all, any]

    compatibility_mode boolean

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

    export_url stringrequired

    Get export URL for flow

    layout FlowLayoutEnum (string)

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

    denied_action DeniedActionEnum (string)

    Possible values: [message_continue, message, continue]

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

  • ]

    • evaluate_on_plan boolean

    Evaluate policies during the Flow planning process.

    re_evaluate_policies boolean

    Evaluate policies when the Stage is present to the user.

    order integerrequired

    Possible values: >= -2147483648 and <= 2147483647

    policy_engine_mode PolicyEngineMode (string)

    Possible values: [all, any]

    invalid_response_action InvalidResponseActionEnum (string)

    Possible values: [retry, restart, restart_with_context]

    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.

    next_planned_stage

    object

    required

    FlowStageBinding Serializer

    pk uuidrequired
    policybindingmodel_ptr_id uuidrequired
    target uuidrequired
    stage uuidrequired

    stage_obj

    object

    required

    Stage Serializer

    pk uuidrequired
    name stringrequired
    component stringrequired

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

    verbose_name stringrequired

    Return object's verbose_name

    verbose_name_plural stringrequired

    Return object's plural verbose_name

    meta_model_name stringrequired

    Return internal model name

    flow_set

    object[]

  • Array [

    • pk uuidrequired
    policybindingmodel_ptr_id uuidrequired
    name stringrequired
    slug stringrequired

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

    Visible in the URL.

    title stringrequired

    Shown as the Title in Flow pages.

    designation FlowDesignationEnum (string)required

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

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

    background stringrequired

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

    policy_engine_mode PolicyEngineMode (string)

    Possible values: [all, any]

    compatibility_mode boolean

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

    export_url stringrequired

    Get export URL for flow

    layout FlowLayoutEnum (string)

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

    denied_action DeniedActionEnum (string)

    Possible values: [message_continue, message, continue]

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

  • ]

    • evaluate_on_plan boolean

    Evaluate policies during the Flow planning process.

    re_evaluate_policies boolean

    Evaluate policies when the Stage is present to the user.

    order integerrequired

    Possible values: >= -2147483648 and <= 2147483647

    policy_engine_mode PolicyEngineMode (string)

    Possible values: [all, any]

    invalid_response_action InvalidResponseActionEnum (string)

    Possible values: [retry, restart, restart_with_context]

    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.

    plan_context

    object

    required

    Get the plan's context, sanitized

    property name* any

    Get the plan's context, sanitized

    session_id stringrequired

    Get a unique session ID

    is_completed booleanrequired
curl -L '/api/v3/flows/inspector/:flow_slug/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
Request Collapse all
Base URL
/api/v3
Auth
Parameters
— pathrequired