From 4afcdc49d14855c0c3a4fd4558d0f81906db3ffb Mon Sep 17 00:00:00 2001 From: Francis Lavoie Date: Thu, 26 Nov 2020 22:31:25 -0500 Subject: docs: Mention {http.auth.user.id} placeholder in basicauth JSON docs (#3886) --- modules/caddyhttp/caddyauth/caddyauth.go | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'modules/caddyhttp/caddyauth') diff --git a/modules/caddyhttp/caddyauth/caddyauth.go b/modules/caddyhttp/caddyauth/caddyauth.go index a88bff6..3a0a2a0 100644 --- a/modules/caddyhttp/caddyauth/caddyauth.go +++ b/modules/caddyhttp/caddyauth/caddyauth.go @@ -30,6 +30,11 @@ func init() { // Authentication is a middleware which provides user authentication. // Rejects requests with HTTP 401 if the request is not authenticated. // +// After a successful authentication, the placeholder +// `{http.auth.user.id}` will be set to the username, and also +// `{http.auth.user.*}` placeholders may be set for any authentication +// modules that provide user metadata. +// // Its API is still experimental and may be subject to change. type Authentication struct { // A set of authentication providers. If none are specified, -- cgit v1.2.3