From 58baf97e2dbd2e01b4d86d43f125a6930125aa00 Mon Sep 17 00:00:00 2001 From: hexeth <7627137+hexeth@users.noreply.github.com> Date: Tue, 9 Nov 2021 12:17:36 -0800 Subject: [PATCH] website/docs: Add additionalHeaders to attributes list (#1754) * Add additionalHeaders to attributes list Added additional headers with example of usage * Update user.md --- website/docs/user-group/user.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/website/docs/user-group/user.md b/website/docs/user-group/user.md index bf7193a80..db48c7fa3 100644 --- a/website/docs/user-group/user.md +++ b/website/docs/user-group/user.md @@ -20,6 +20,25 @@ Optional flag, when set to false, Tokens created by the user will not expire. See [Troubleshooting access problems](../troubleshooting/access.md), when set, the user gets a more detailed explanation of access decisions. +### `additionalHeaders`: + +:::info +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 +underneath `additionalHeaders`: + +#### Example: +``` +additionalHeaders: + REMOTE-USER: joe.smith + REMOTE-EMAIL: joe@jsmith.com + REMOTE-NAME: Joseph +``` + +These headers will now be passed to the application when the user logs in. Most applications will need to be configured to accept these headers. Some examples of applications that can accept additional headers from an Authentik Proxy Provider are [Grafana](https://grafana.com/docs/grafana/latest/auth/auth-proxy/) and [Tandoor Recipes](https://docs.tandoor.dev/features/authentication/). + ## Object attributes The User object has the following attributes: