public_git/oauth2-proxy
1
0
Fork 0
mirror of https://github.com/oauth2-proxy/oauth2-proxy.git synced 2026-09-29 19:21:13 +02:00
Code Issues Projects Releases Wiki Activity

docs: clarify structured claim header serialization (#3501)

Browse Source 
Signed-off-by: nightcityblade <jackchen@haloailabs.com>
This commit is contained in:
nightcityblade
2026-08-20 07:33:54 +02:00
committed by GitHub
parent d122f0c28e
commit 061685fed3
2 changed files with 22 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs/configuration/alpha_config.md
+11
View File
@@ -167,6 +167,17 @@ injectResponseHeaders:
* `claimSource` - `claim` (session claims either from id token or from profile URL)
* `secretSource` - `value` (base64), `fromFile` (file path)
#### Claim value serialization
`claimSource` converts the selected claim into one or more string header values. Scalars
produce one value, while arrays produce one value per element. Values that cannot be
converted directly to strings, such as objects, are JSON-encoded individually.
Each non-empty value is added separately under the configured header name. An array of
objects therefore produces multiple header values containing one JSON object each, not a
single JSON array. HTTP libraries and intermediaries may expose repeated values as a
comma-joined string, so consumers should retrieve and parse each header value separately.
**Request option:** `preserveRequestValue: true` retains existing header values
**Incompatibility:** Remove legacy flags `pass-user-headers`, `set-xauthrequest`
docs/docs/configuration/alpha_config.md.tmpl
+11
View File
@@ -167,6 +167,17 @@ injectResponseHeaders:
* `claimSource` - `claim` (session claims either from id token or from profile URL)
* `secretSource` - `value` (base64), `fromFile` (file path)
#### Claim value serialization
`claimSource` converts the selected claim into one or more string header values. Scalars
produce one value, while arrays produce one value per element. Values that cannot be
converted directly to strings, such as objects, are JSON-encoded individually.
Each non-empty value is added separately under the configured header name. An array of
objects therefore produces multiple header values containing one JSON object each, not a
single JSON array. HTTP libraries and intermediaries may expose repeated values as a
comma-joined string, so consumers should retrieve and parse each header value separately.
**Request option:** `preserveRequestValue: true` retains existing header values
**Incompatibility:** Remove legacy flags `pass-user-headers`, `set-xauthrequest`