Flow.md

Flow

Properties

Name	Type	Description	Notes
pk	UUID		[readonly]
policybindingmodelPtrId	UUID		[readonly]
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	[readonly]
stages	[UUID]		[readonly]
policies	[UUID]		[readonly]
cacheCount	Int	Get count of cached flows	[readonly]
policyEngineMode	PolicyEngineMode		[optional]
compatibilityMode	Bool	Enable compatibility mode, increases compatibility with password managers on mobile devices.	[optional]
exportUrl	String	Get export URL for flow	[readonly]
layout	FlowLayoutEnum		[optional]
deniedAction	DeniedActionEnum	Configure what should happen when a flow denies access to a user. * `message_continue` - Message Continue * `message` - Message * `continue` - Continue	[optional]
authentication	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	[optional]

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