mirror of
https://github.com/oauth2-proxy/oauth2-proxy.git
synced 2026-09-30 11:41:19 +02:00
NirronCDandJan Larwig
a2f2223d2b
* doc: adjust regarding description of behaviour Signed-off-by: NirronCD <nirron@rietto.com> * doc:changed style, added suggested Signed-off-by: NirronCD <nirron@rietto.com> * doc: minor fix to docusaurus metadata syntax Signed-off-by: NirronCD <nirron@rietto.com> * docs: improved clarity for how the proxy behaves in different scenarios Signed-off-by: Jan Larwig <jan@larwig.com> --------- Signed-off-by: NirronCD <nirron@rietto.com> Signed-off-by: Jan Larwig <jan@larwig.com> Co-authored-by: Jan Larwig <jan@larwig.com>
12 lines
865 B
Markdown
12 lines
865 B
Markdown
---
|
|
id: behaviour
|
|
title: Behaviour
|
|
---
|
|
|
|
1. Any request passing through the proxy (and not matched by `--skip-auth-route`) is checked for the proxy's session cookie (`--cookie-name`) (or, if allowed, a JWT token - see `--skip-jwt-bearer-tokens`).
|
|
2. If authentication is required but missing then the user is asked to log in and redirected to the authentication provider (unless it is an Ajax request, i.e. one with `Accept: application/json`, in which case 401 Unauthorized is returned)
|
|
3. After returning from the authentication provider, the oauth tokens are stored in the configured session store (cookie, redis, ...) and a cookie is set
|
|
4. The request is forwarded to the upstream server with added user info and authentication headers (depending on the configuration)
|
|
|
|
Notice that the proxy also provides a number of useful [endpoints](features/endpoints.md).
|