Struct Flow

pub struct Flow {

    pub pk: Uuid,
    pub policybindingmodel_ptr_id: Uuid,
    pub name: String,
    pub slug: String,
    pub title: String,
    pub designation: FlowDesignationEnum,
    pub background: String,
    pub stages: Vec<Uuid>,
    pub policies: Vec<Uuid>,
    pub cache_count: i32,
    pub policy_engine_mode: Option<PolicyEngineMode>,
    pub compatibility_mode: Option<bool>,
    pub export_url: String,
    pub layout: Option<FlowLayoutEnum>,
    pub denied_action: Option<DeniedActionEnum>,
    pub authentication: Option<AuthenticationEnum>,
}

Flow : Flow Serializer

Fields

pk: Uuid

policybindingmodel_ptr_id: Uuid

name: String

slug: String

Visible in the URL.

title: String

Shown as the Title in Flow pages.

designation: FlowDesignationEnum

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

background: String

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

stages: Vec<Uuid>

policies: Vec<Uuid>

cache_count: i32

Get count of cached flows

policy_engine_mode: Option<PolicyEngineMode>

compatibility_mode: Option<bool>

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

export_url: String

Get export URL for flow

layout: Option<FlowLayoutEnum>

denied_action: Option<DeniedActionEnum>

Configure what should happen when a flow denies access to a user. * message_continue - Message Continue * message - Message * continue - Continue

authentication: Option<AuthenticationEnum>

Required level of authentication and authorization to access a flow. * none - None * require_authenticated - Require Authenticated * require_unauthenticated - Require Unauthenticated * require_superuser - Require Superuser * require_outpost - Require Outpost

Implementations

impl Flow

pub fn new( pk: Uuid, policybindingmodel_ptr_id: Uuid, name: String, slug: String, title: String, designation: FlowDesignationEnum, background: String, stages: Vec<Uuid>, policies: Vec<Uuid>, cache_count: i32, export_url: String, ) -> Flow

Flow Serializer

Trait Implementations

impl Clone for Flow

fn clone(&self) -> Flow

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Flow

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Flow

fn default() -> Flow

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Flow

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Flow

fn eq(&self, other: &Flow) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Flow

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Flow