Sign in
flows

Flow Viewset

get/flows/instances/{slug}/

Path parameters

slugstring required

Visible in the URL.

Response

pkstring uuid required
policybindingmodel_ptr_idstring uuid required
namestring required
slugstring required

Visible in the URL.

titlestring required

Shown as the Title in Flow pages.

designation'authentication' | 'authorization' | 'invalidation' | 'enrollment' | 'unenrollment' | 'recovery' | 'stage_configuration' required
backgroundstring

Background shown during execution

background_urlstring required

Get the URL to the background image

stagesstring[] required
policiesstring[] required
cache_countinteger required

Get count of cached flows

policy_engine_mode'all' | 'any'
compatibility_modeboolean

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

export_urlstring required

Get export URL for flow

layout'stacked' | 'content_left' | 'content_right' | 'sidebar_left' | 'sidebar_right' | 'sidebar_left_frame_background' | 'sidebar_right_frame_background'
denied_action'message_continue' | 'message' | 'continue'
authentication'none' | 'require_authenticated' | 'require_unauthenticated' | 'require_superuser' | 'require_redirect' | 'require_outpost' | 'require_token'

Changes

No recorded changes to this endpoint across all 11 revisions of this API.