habsi/authentik
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

website/docs: add docs for different flow executors

Browse Source 
Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
This commit is contained in:
Jens Langhammer
2022-03-09 23:36:09 +01:00
parent de17207c68
commit a9f095d1d9
5 changed files with 47 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
website/docs/flow/executors/headless.md Normal file
View File

@ -0,0 +1,11 @@
---
title: Headless
---
The headless flow executor is used by clients which don't have access to the web interface. It is currently used by the LDAP outpost to authenticate users.
The following stages are supported:
- [**identification**](../stages/identification/)
- [**password**](../stages/password/)
- [**authenticator_validate**](../stages/authenticator_validate/) (currently only DUO devices are supported)

5
website/docs/flow/executors/if-flow.md Normal file
View File

@ -0,0 +1,5 @@
---
title: Default (Web)
---
This is the default, web-based environment flows are executed in. All stages are compatible with this environment and no limitations are imposed.

14
website/docs/flow/executors/user-settings.md Normal file
View File

@ -0,0 +1,14 @@
---
title: User settings
---
:::info
Requires authentik 2022.3.1
:::
The user interface (`/if/user/`) embeds a downsized flow executor to allow the user to configure their profile using custom stages and prompts.
This executor only supports [**prompt**](../stages/prompt/) stages. If the configured flow contains another stage, a button will be shown to open the default executor.
Because the stages in a flow can change during it execution, this executor will redirect the user to the default interface *if* a non-supported stage is returned.
To configure which flow is used for this, configure it in the tenant settings.