mirrors
/
authentik
mirror of https://github.com/goauthentik/authentik.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
authentik/docs/flow/flows.md

46 lines
2.6 KiB
Markdown
Raw Normal View History

docs: add docs for flows, start docs for stages
2020-05-30 21:36:01 +01:00
# Flows
Flows are a method of describing a sequence of stages. A stage represents a single verification or logic step. They are used to authenticate users, enroll them, and more.
docs: add example for login flow
2020-06-05 16:29:08 +01:00
Upon Flow execution, a plan is generated, which contains all stages. This means upon execution, all attached policies are evaluated. This behaviour can be altered by enabling the **Re-evaluate Policies** option on the binding.
docs: add docs for flows, start docs for stages
2020-05-30 21:36:01 +01:00
To determine which flow is linked, passbook searches all Flows with the required designation and chooses the first instance the current user has access to.
## Permissions
Flows can have policies assigned to them, which determines if the current user is allowed to see and use this flow.
## Designation
Flows are designated for a single Purpose. This designation changes when a Flow is used. The following designations are available:
### Authentication
This is designates a flow to be used for authentication.
docs: add example for login flow
2020-06-05 16:29:08 +01:00
The authentication flow should always contain a [**User Login**](stages/user_login.md) stage, which attaches the staged user to the current session.
docs: add docs for flows, start docs for stages
2020-05-30 21:36:01 +01:00
### Invalidation
This designates a flow to be used for the invalidation of a session.
docs: add example for login flow
2020-06-05 16:29:08 +01:00
This stage should always contain a [**User Logout**](stages/user_logout.md) stage, which resets the current session.
docs: add docs for flows, start docs for stages
2020-05-30 21:36:01 +01:00
### Enrollment
docs: add example for login flow
2020-06-05 16:29:08 +01:00
This designates a flow for enrollment. This flow can contain any amount of Prompt stages, E-Mail verification or Captchas. At the end to create the user, you can use the [**User Write**](stages/user_write.md) stage, which either updates the currently staged user, or if none exists, creates a new one.
docs: add docs for flows, start docs for stages
2020-05-30 21:36:01 +01:00
### Unenrollment
docs: add example for login flow
2020-06-05 16:29:08 +01:00
This designates a flow for unenrollment. This flow can contain any amount of verification, like [**E-Mail**](stages/email/index.md) or [**Captcha**](stages/captcha/index.md). To finally delete the account, use the [**User Delete**](stages/user_delete.md) stage.
docs: add docs for flows, start docs for stages
2020-05-30 21:36:01 +01:00
### Recovery
docs: add example for login flow
2020-06-05 16:29:08 +01:00
This designates a flow for recovery. This flow normally contains an [**Identification**](stages/identification/index.md) stage to find the user. Then it can contain any amount of verification, like [**E-Mail**](stages/email/index.md) or [**Captcha**](stages/captcha/index.md).
Afterwards, use the [**Prompt**](stages/prompt/index.md) stage to ask the user for a new password and use [**User Write**](stages/user_write.md) to update the password.
docs: add docs for flows, start docs for stages
2020-05-30 21:36:01 +01:00
### Change Password
docs: add example for login flow
2020-06-05 16:29:08 +01:00
This designates a flow for password changing. This flow can contain any amount of verification, like [**E-Mail**](stages/email/index.md) or [**Captcha**](stages/captcha/index.md).
Afterwards, use the [**Prompt**](stages/prompt/index.md) stage to ask the user for a new password and use [**User Write**](stages/user_write.md) to update the password.