Flow.md

Flow

Flow Serializer

Properties

Name	Type	Description	Notes
pk	UUID		[readonly]
policybindingmodel_ptr_id	UUID		[readonly]
name	str
slug	str	Visible in the URL.
title	str	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.
background	str	Background shown during execution	[optional]
background_url	str	Get the URL to the background image	[readonly]
background_themed_urls	ThemedUrls		[readonly]
stages	List[UUID]		[readonly]
policies	List[UUID]		[readonly]
cache_count	int	Get count of cached flows	[readonly]
policy_engine_mode	PolicyEngineMode		[optional]
compatibility_mode	bool	Enable compatibility mode, increases compatibility with password managers on mobile devices.	[optional]
export_url	str	Get export URL for flow	[readonly]
layout	FlowLayoutEnum		[optional]
denied_action	DeniedActionEnum	Configure what should happen when a flow denies access to a user.	[optional]
authentication	AuthenticationEnum	Required level of authentication and authorization to access a flow.	[optional]

Example

from authentik_client.models.flow import Flow

# TODO update the JSON string below
json = "{}"
# create an instance of Flow from a JSON string
flow_instance = Flow.from_json(json)
# print the JSON string representation of the object
print(Flow.to_json())

# convert the object into a dict
flow_dict = flow_instance.to_dict()
# create an instance of Flow from a dict
flow_from_dict = Flow.from_dict(flow_dict)

[Back to Model list] [Back to API list] [Back to README]