This repository has been archived on 2024-05-31. You can view files and clone it, but cannot push or open issues or pull requests.
authentik/website/docs/flow/examples.md

56 lines
1.9 KiB
Markdown
Raw Permalink Normal View History

---
title: Example Flows
---
2020-09-08 21:18:42 +00:00
:::info
You can apply these flows multiple times to stay updated, however this will discard all changes you've made.
:::
2020-09-08 21:18:42 +00:00
:::info
The example flows provided below will **override** the default flows, please review the contents of the example flow before importing and consider exporting the affected existing flows first.
:::
2020-09-08 21:18:42 +00:00
## Enrollment (2 Stage)
Flow: right-click [here](/flows/enrollment-2-stage.akflow) and save the file.
2020-09-08 21:18:42 +00:00
Sign-up flow for new users, which prompts them for their username, email, password and name. No verification is done. Users are also immediately logged on after this flow.
## Enrollment with email verification
Flow: right-click [here](/flows/enrollment-email-verification.akflow) and save the file.
2020-09-08 21:18:42 +00:00
Same flow as above, with an extra email verification stage.
You'll probably have to adjust the Email stage and set your connection details.
## Two-factor Login
Flow: right-click [here](/flows/login-2fa.akflow) and save the file.
2020-09-08 21:18:42 +00:00
Login flow which follows the default pattern (username/email, then password), but also checks for the user's OTP token, if they have one configured
## Login with conditional Captcha
Flow: right-click [here](/flows/login-conditional-captcha.akflow) and save the file.
2020-09-08 21:18:42 +00:00
Login flow which conditionally shows the users a captcha, based on the reputation of their IP and Username.
By default, the captcha test keys are used. You can get a proper key [here](https://www.google.com/recaptcha/intro/v3.html)
## Recovery with email verification
Flow: right-click [here](/flows/recovery-email-verification.akflow) and save the file.
2020-09-08 21:18:42 +00:00
Recovery flow, the user is sent an email after they've identified themselves. After they click on the link in the email, they are prompted for a new password and immediately logged on.
## User deletion
Flow: right-click [here](/flows/unenrollment.akflow) and save the file.
2020-09-08 21:18:42 +00:00
Flow for users to delete their account,
:::warning
This is done without any warning.
:::