From fe3e7e8a7140c04c1f5422462e513eaee24bcae1 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 20 Apr 2023 15:34:40 -0400 Subject: [PATCH] Tweak documentation --- docs/administration/authentication/overview.md | 2 +- docs/configuration/remote-authentication.md | 16 ++++++++-------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/administration/authentication/overview.md b/docs/administration/authentication/overview.md index 6b46264c2..8a8b8f60b 100644 --- a/docs/administration/authentication/overview.md +++ b/docs/administration/authentication/overview.md @@ -26,7 +26,7 @@ REMOTE_AUTH_BACKEND = 'netbox.authentication.RemoteUserBackend' Another option for remote authentication in NetBox is to enable HTTP header-based user assignment. The front end HTTP server (e.g. nginx or Apache) performs client authentication as a process external to NetBox, and passes information about the authenticated user via HTTP headers. By default, the user is assigned via the `REMOTE_USER` header, but this can be customized via the `REMOTE_AUTH_HEADER` configuration parameter. -Optionally, user profile information can be supplied by `REMOTE_USER_FIRST_NAME`, `REMOTE_USER_LAST_NAME` and `REMOTE_USER_EMAIL` headers. These are saved to the users profile during the authentication process. These headers can be customized like the ``REMOTE_USER`` header. +Optionally, user profile information can be supplied by `REMOTE_USER_FIRST_NAME`, `REMOTE_USER_LAST_NAME` and `REMOTE_USER_EMAIL` headers. These are saved to the users profile during the authentication process. These headers can be customized like the `REMOTE_USER` header. ### Single Sign-On (SSO) diff --git a/docs/configuration/remote-authentication.md b/docs/configuration/remote-authentication.md index fd9306fd6..fd95adef5 100644 --- a/docs/configuration/remote-authentication.md +++ b/docs/configuration/remote-authentication.md @@ -79,6 +79,14 @@ When remote user authentication is in use, this is the name of the HTTP header w --- +## REMOTE_AUTH_USER_EMAIL + +Default: `'HTTP_REMOTE_USER_EMAIL'` + +When remote user authentication is in use, this is the name of the HTTP header which informs NetBox of the email address of the currently authenticated user. For example, to use the request header `X-Remote-User-Email` it needs to be set to `HTTP_X_REMOTE_USER_EMAIL`. (Requires `REMOTE_AUTH_ENABLED`.) + +--- + ## REMOTE_AUTH_USER_FIRST_NAME Default: `'HTTP_REMOTE_USER_FIRST_NAME'` @@ -95,14 +103,6 @@ When remote user authentication is in use, this is the name of the HTTP header w --- -## REMOTE_AUTH_USER_EMAIL - -Default: `'HTTP_REMOTE_USER_EMAIL'` - -When remote user authentication is in use, this is the name of the HTTP header which informs NetBox of the email address of the currently authenticated user. For example, to use the request header `X-Remote-User-Email` it needs to be set to `HTTP_X_REMOTE_USER_EMAIL`. (Requires `REMOTE_AUTH_ENABLED`.) - ---- - ## REMOTE_AUTH_SUPERUSER_GROUPS Default: `[]` (Empty list)