From 84e126a32c4f2ace9b6e694e978c2b997db0df8f Mon Sep 17 00:00:00 2001 From: Jens Langhammer Date: Thu, 11 Nov 2021 16:15:40 +0100 Subject: [PATCH] website/docs: add group hierarchy docs Signed-off-by: Jens Langhammer --- website/docs/user-group/group.md | 13 +++++++++++++ website/docs/user-group/user.md | 3 ++- website/sidebars.js | 3 ++- 3 files changed, 17 insertions(+), 2 deletions(-) create mode 100644 website/docs/user-group/group.md diff --git a/website/docs/user-group/group.md b/website/docs/user-group/group.md new file mode 100644 index 000000000..2e287f61e --- /dev/null +++ b/website/docs/user-group/group.md @@ -0,0 +1,13 @@ +--- +title: Group +--- + +## Hierarchy + +Groups can be children of another group. Members of children groups are effective members of the parent group. + +When you bind a group to an application or flow, any members of any child group of the selected group will have access. + +## Attributes + +Attributes of groups are recursively merged, for all groups the user is a *direct* member of. diff --git a/website/docs/user-group/user.md b/website/docs/user-group/user.md index db48c7fa3..8c347b706 100644 --- a/website/docs/user-group/user.md +++ b/website/docs/user-group/user.md @@ -26,10 +26,11 @@ See [Troubleshooting access problems](../troubleshooting/access.md), when set, t This field is only used by the Proxy Provider. ::: -Some applications can be configured to create new users using header information forwarded from Authentik. You can forward additional header information by adding each header +Some applications can be configured to create new users using header information forwarded from Authentik. You can forward additional header information by adding each header underneath `additionalHeaders`: #### Example: + ``` additionalHeaders: REMOTE-USER: joe.smith diff --git a/website/sidebars.js b/website/sidebars.js index 96a47ad94..bcf0a9f0b 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -12,7 +12,8 @@ module.exports = { type: "category", label: "Users & Groups", items: [ - "user-group/user" + "user-group/user", + "user-group/group", ] }, {