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

website: fix reference to flow stage binding option (#6701)

Browse Source 
the option name was changed a while back but the docs still used the old name

Signed-off-by: Jens Langhammer <jens@goauthentik.io>
This commit is contained in:
Jens L
2023-08-30 20:10:36 +02:00
committed by GitHub
parent 3afff1bae9
commit 9d894528e3
18 changed files with 131 additions and 142 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
website/docs/flow/examples/snippets.md
View File

@ -16,7 +16,7 @@ plan.redirect("https://foo.bar")
return False
```
This policy should be bound to the stage after your redirect should happen. For example, if you have an identification and a password stage, and you want to redirect after identification, bind the policy to the password stage. Make sure the policy binding is set to re-evaluate policies.
This policy should be bound to the stage after your redirect should happen. For example, if you have an identification and a password stage, and you want to redirect after identification, bind the policy to the password stage. Make sure the stage binding's option _Evaluate when stage is run_ is enabled.
### Deny flow when user is authenticated

2
website/docs/flow/index.md
View File

@ -10,7 +10,7 @@ For example, a standard login flow would consist of the following stages:
- Password, the user's password is checked against the hash in the database
- Log the user in
Upon flow execution, a plan containing all stages is generated. This means that all attached policies are evaluated upon execution. This behaviour can be altered by enabling the **Re-evaluate Policies** option on the binding.
Upon flow execution, a plan containing all stages is generated. This means that all attached policies are evaluated upon execution. This behaviour can be altered by enabling the **Evaluate when stage is run** option on the binding.
To determine which flow is linked, authentik searches all flows with the required designation and chooses the first instance the current user has access to.

2
website/docs/flow/inspector.md
View File

@ -14,7 +14,7 @@ The following infos are shown in the inspector
## Next stage
This is the currently planned next stage. If you have stage bindings configured to evaluate on plan (default), then you will see the result here. If you however have them configured to re-evaluate, then this will not show up here, since the results will vary based on your input.
This is the currently planned next stage. If you have stage bindings configured to _Evaluate when flow is planned_, then you will see the result here. If you however have them configured to re-evaluate (_Evaluate when stage is run_), then this will not show up here, since the results will vary based on your input.
Shown is the name and kind of the stage, as well as the unique ID.

2
website/docs/flow/stages/deny.md
View File

@ -6,5 +6,5 @@ This stage stops the execution of a flow. This can be used to conditionally deny
even if they are not signed in (and permissions can't be checked via groups).
:::caution
To effectively use this stage, make sure to **disable** _Evaluate on plan_ on the Stage binding.
To effectively use this stage, make sure _Evaluate when flow is planned_ is **disable** on the Stage binding.
:::

2
website/docs/flow/stages/password/index.md
View File

@ -26,4 +26,4 @@ return DuoDevice.objects.filter(user=request.context['pending_user'], confirmed=
Afterwards, bind the policy you've created to the stage binding of the password stage.
Make sure to uncheck _Evaluate on plan_ and check _Re-evaluate policies_, otherwise an invalid result will be cached.
Make sure to uncheck _Evaluate when flow is planned_ and check _Evaluate when stage is run_, otherwise an invalid result will be cached.