git.iko.soy/typeable/oauth2-proxy
on master help sign in
Document set_xauthrequest with pass_access_token (#829)

* Document set_xauthrequest with pass_access_token Document feature implemented in https://github.com/oauth2-proxy/oauth2-proxy/pull/68 The feature is already decribed in in the nginx example but not clearly on each respective parameters documentation. * Update docs/configuration/configuration.md Co-authored-by: Nick Meves <nick.meves@greenhouse.io> Co-authored-by: Nick Meves <nick.meves@greenhouse.io>

commit420a34f8146c3f93268d3cdee0ad8606b69d30c1 authorPhilippe Pepiot <phil@philpep.org> dateWed 14 Oct 2020, 18:17 (6 years ago) parentf4c292b
1 file changed+2−2
compare with master
unifiedsplit
docs/configuration/configuration.md+2−2
docs/configuration/configuration.md+2−2
@@ -79,7 +79,7 @@ An example [oauth2-proxy.cfg]({{ site.gitweb }}/contrib/oauth2-proxy.cfg.example
7979| `--oidc-issuer-url` | string | the OpenID Connect issuer URL, e.g. `"https://accounts.google.com"` | |
8080| `--oidc-jwks-url` | string | OIDC JWKS URI for token verification; required if OIDC discovery is disabled | |
8181| `--oidc-groups-claim` | string | which claim contains the user groups | `"groups"` |
82−| `--pass-access-token` | bool | pass OAuth access_token to upstream via X-Forwarded-Access-Token header | false |
82+| `--pass-access-token` | bool | pass OAuth access_token to upstream via X-Forwarded-Access-Token header. When used with `--set-xauthrequest` this adds the X-Auth-Request-Access-Token header to the response | false |
8383| `--pass-authorization-header` | bool | pass OIDC IDToken to upstream via Authorization Bearer header | false |
8484| `--pass-basic-auth` | bool | pass HTTP Basic Auth, X-Forwarded-User, X-Forwarded-Email and X-Forwarded-Preferred-Username information to upstream | true |
8585| `--prefer-email-to-user` | bool | Prefer to use the Email address as the Username when passing information to upstream. Will only use Username if Email is unavailable, e.g. htaccess authentication. Used in conjunction with `--pass-basic-auth` and `--pass-user-headers` | false |
@@ -113,7 +113,7 @@ An example [oauth2-proxy.cfg]({{ site.gitweb }}/contrib/oauth2-proxy.cfg.example
113113| `--scope` | string | OAuth scope specification | |
114114| `--session-cookie-minimal` | bool | strip OAuth tokens from cookie session stores if they aren't needed (cookie session store only) | false |
115115| `--session-store-type` | string | [Session data storage backend](configuration/sessions); redis or cookie | cookie |
116−| `--set-xauthrequest` | bool | set X-Auth-Request-User, X-Auth-Request-Groups, X-Auth-Request-Email and X-Auth-Request-Preferred-Username response headers (useful in Nginx auth_request mode) | false |
116+| `--set-xauthrequest` | bool | set X-Auth-Request-User, X-Auth-Request-Groups, X-Auth-Request-Email and X-Auth-Request-Preferred-Username response headers (useful in Nginx auth_request mode). When used with `--pass-access-token`, X-Auth-Request-Access-Token is added to response headers. | false |
117117| `--set-authorization-header` | bool | set Authorization Bearer response header (useful in Nginx auth_request mode) | false |
118118| `--set-basic-auth` | bool | set HTTP Basic Auth information in response (useful in Nginx auth_request mode) | false |
119119| `--signature-key` | string | GAP-Signature request signature key (algorithm:secretkey) | |