From 264fb1251019c7d23db04c18bfe8da4e8b65db52 Mon Sep 17 00:00:00 2001 From: LandaMm Date: Sat, 17 May 2025 23:15:28 +0200 Subject: [PATCH] feat: decribed user authorization flow through web url --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 6af48c6..ab778a0 100644 --- a/README.md +++ b/README.md @@ -70,6 +70,22 @@ HSP Guard checks the user’s assigned permissions and responds with the authori --- +## 🔄 User Authorization Flow + +When a user tries to access a home lab service that requires authentication: + +1. The application will **offer an authorization URL** to the user. +2. The user follows the URL and is taken to the **HSP Guard login page**. +3. The user selects or signs into an account they wish to use for that service. +4. Once authenticated and authorized, the user is redirected to the **application-defined redirect URL**. +5. The application can now: + - Retrieve a **JWT token** from the redirect callback + - **Optionally cache the session/token** to avoid prompting the user every time + +This process is similar to how external identity providers like **Google Sign-In** or **GitHub OAuth** work — providing a seamless and secure authentication experience for the user. + +--- + ## ⚙️ Integrating New Services & Tools When a new service or tool is installed: