From ed3f36e72abe640cafb13b9bedef6dd6f6c94f30 Mon Sep 17 00:00:00 2001 From: Jens Langhammer Date: Thu, 5 Jan 2023 12:38:38 +0100 Subject: [PATCH] website/docs: update redirect docs closes #4248 Signed-off-by: Jens Langhammer --- website/docs/expressions/_functions.md | 2 +- website/docs/policies/expression.mdx | 11 +++++++++-- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/website/docs/expressions/_functions.md b/website/docs/expressions/_functions.md index 984de8e8d..ef9aa0905 100644 --- a/website/docs/expressions/_functions.md +++ b/website/docs/expressions/_functions.md @@ -18,7 +18,7 @@ Example: user_email_local = regex_replace(request.user.email, '(.+)@.+', '') ``` -### `list_flatten(value: list[Any] | Any) -> Optional[Any}` +### `list_flatten(value: list[Any] | Any) -> Optional[Any]` Flatten a list by either returning its first element, None if the list is empty, or the passed in object if its not a list. diff --git a/website/docs/policies/expression.mdx b/website/docs/policies/expression.mdx index 39376a91a..968613fe6 100644 --- a/website/docs/policies/expression.mdx +++ b/website/docs/policies/expression.mdx @@ -29,7 +29,11 @@ ak_message("Access denied") return False ``` -### `ak_call_policy(name: str, **kwargs) -> PolicyResult` (2021.12+) +### `ak_call_policy(name: str, **kwargs) -> PolicyResult` + +:::info +Requires authentik 2021.12 +::: Call another policy with the name _name_. Current request is passed to policy. Key-word arguments can be used to modify the request's context. @@ -87,7 +91,10 @@ Additionally, when the policy is executed from a flow, every variable from the f This includes the following: - `context['flow_plan']`: The actual flow plan itself, can be used to inject stages. -- `context['redirect']`: The URL the user should be redirected to after the flow execution succeeds. (Optional) + + - `context['flow_plan'].context`: The context of the currently active flow, which differs from the policy context. Some fields of flow plan context are passed to the root context, and updated from it, like 'prompt_data', but not every variable + - `context['flow_plan'].context['redirect']`: The URL the user should be redirected to after the flow execution succeeds. (Optional) + - `context['prompt_data']`: Data which has been saved from a prompt stage or an external source. (Optional) - `context['application']`: The application the user is in the process of authorizing. (Optional) - `context['source']`: The source the user is authenticating/enrolling with. (Optional)