1
0
mirror of https://github.com/oauth2-proxy/oauth2-proxy.git synced 2025-06-23 00:40:46 +02:00

docs: additional notes about available claims for HeaderValue (#2674)

* docs: additional notes on HeaderValue

* docs: add code comments

* fix missing preferred_username

* regenerate docs

* add changelog entry

---------

Co-authored-by: afsu <saf@zjuici.com>
Co-authored-by: Jan Larwig <jan@larwig.com>
This commit is contained in:
af su
2024-07-19 04:31:19 +08:00
committed by GitHub
parent a22668eb8c
commit 211c605875
3 changed files with 5 additions and 3 deletions

View File

@ -30,7 +30,8 @@ type HeaderValue struct {
// ClaimSource allows loading a header value from a claim within the session
type ClaimSource struct {
// Claim is the name of the claim in the session that the value should be
// loaded from.
// loaded from. Available claims: `access_token` `id_token` `created_at`
// `expires_on` `refresh_token` `email` `user` `groups` `preferred_username`.
Claim string `json:"claim,omitempty"`
// Prefix is an optional prefix that will be prepended to the value of the