aboutsummaryrefslogtreecommitdiffstats
path: root/src/tools/emcoui/middle_end/authproxy/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/tools/emcoui/middle_end/authproxy/README.md')
-rw-r--r--src/tools/emcoui/middle_end/authproxy/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/src/tools/emcoui/middle_end/authproxy/README.md b/src/tools/emcoui/middle_end/authproxy/README.md
new file mode 100644
index 00000000..1d68a431
--- /dev/null
+++ b/src/tools/emcoui/middle_end/authproxy/README.md
@@ -0,0 +1,16 @@
+
+Authproxy is part of middleend and it exposes following 3 apis
+1. **/v1/login**
+ - Redirects user to keycloak login page.
+ - Sets a cookie with original URL
+2. **/v1/callback**
+ - After successful login gets auth code and exchange it for token.
+ - Set id_token and access_token in cookie and redirects to original URL
+3. **/v1/auth**
+ - Retrieve idtoken from cookie and verifies the JWT.
+ - If id_token is valid then access to resources else redirects to login page.
+
+Required inputs of authproxy comes from authproxy section of helm config
+- Issuer
+- Redirect URI
+- Client id