[PR #3266] [CLOSED] feat: adds OIDC support #4313

New issue

Closed

opened 2026-03-17 01:51:39 +03:00 by kerem · 0 comments

kerem commented

2026-03-17 01:51:39 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/hoppscotch/hoppscotch/pull/3266
Author: @becelot
Created: 8/19/2023
Status: ❌ Closed

Base: main ← Head: feat/oidc

📝 Commits (10+)

363dac1 feat: adds oidc backend implementation
58d3681 feat: adds oidc support to frontend
9bae266 feat: adds oidc support to sh-admin
459b35f Merge branch 'release/2023.8.0' into feat/oidc
0fad40a Merge branch 'release/2023.8.0' into feat/oidc
6873041 chore: update pnpm-lock
057ecf9 feat: proper support for OIDC scopes
5c57189 docs: adds OIDC to supported sign-in options
9717851 chore: fix linter issue
61b2920 chore: adjust toast text

📊 Changes

49 files changed (+399 additions, -16 deletions)

View changed files

📝 .env.example (+13 -0)
📝 README.md (+1 -0)
📝 packages/hoppscotch-backend/package.json (+2 -0)
📝 packages/hoppscotch-backend/src/auth/auth.controller.ts (+27 -0)
📝 packages/hoppscotch-backend/src/auth/auth.module.ts (+3 -0)
➕ packages/hoppscotch-backend/src/auth/guards/oidc.guard.ts (+33 -0)
📝 packages/hoppscotch-backend/src/auth/helper.ts (+1 -0)
➕ packages/hoppscotch-backend/src/auth/strategies/oidc.strategy.ts (+82 -0)
➕ packages/hoppscotch-common/assets/icons/auth/oidc.svg (+36 -0)
📝 packages/hoppscotch-common/locales/af.json (+1 -0)
📝 packages/hoppscotch-common/locales/ar.json (+1 -0)
📝 packages/hoppscotch-common/locales/ca.json (+1 -0)
📝 packages/hoppscotch-common/locales/cn.json (+1 -0)
📝 packages/hoppscotch-common/locales/cs.json (+1 -0)
📝 packages/hoppscotch-common/locales/da.json (+1 -0)
📝 packages/hoppscotch-common/locales/de.json (+1 -0)
📝 packages/hoppscotch-common/locales/el.json (+1 -0)
📝 packages/hoppscotch-common/locales/en.json (+1 -0)
📝 packages/hoppscotch-common/locales/es.json (+1 -0)
📝 packages/hoppscotch-common/locales/fi.json (+1 -0)

...and 29 more files

📄 Description

Closes #3001

Description

The PR adds the option to configure your own OIDC client in the self-hosted version. It expands on top of the conditional auth provider implementations added in https://github.com/hoppscotch/hoppscotch/pull/3225 and https://github.com/hoppscotch/hoppscotch/pull/3204. To enable the OIDC sign in, you need to fill in the OIDC configuration options (client id, secret, and issuer endpoints) in .env and additionally enable the OIDC auth provider in VITE_ALLOWED_AUTH_PROVIDERS.

You can also configure the login button text if you want to, e.g. Login with COMPANY SSO.

Checks

My pull request adheres to the code style of this project
My code requires changes to the documentation
I have updated the documentation as required
All the tests have passed

Additional Information

The implementation is tested with KeyCloak. I will provide setup documentation for both hoppscotch and different Identity providers in a second PR after this is merged.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/hoppscotch/hoppscotch/pull/3266 **Author:** [@becelot](https://github.com/becelot) **Created:** 8/19/2023 **Status:** ❌ Closed **Base:** `main` ← **Head:** `feat/oidc` --- ### 📝 Commits (10+) - [`363dac1`](https://github.com/hoppscotch/hoppscotch/commit/363dac1ef5ea8538273165183133e36c0afbd099) feat: adds oidc backend implementation - [`58d3681`](https://github.com/hoppscotch/hoppscotch/commit/58d3681d7fe24ed712906dcc8c93cd2d1fffcb38) feat: adds oidc support to frontend - [`9bae266`](https://github.com/hoppscotch/hoppscotch/commit/9bae266b073b357e018e84ac963ed4312b46ba22) feat: adds oidc support to sh-admin - [`459b35f`](https://github.com/hoppscotch/hoppscotch/commit/459b35ff4779536e39dc28ef1386201ab995b09d) Merge branch 'release/2023.8.0' into feat/oidc - [`0fad40a`](https://github.com/hoppscotch/hoppscotch/commit/0fad40a66fed3d7ce14b4360e33c3ec026bd2547) Merge branch 'release/2023.8.0' into feat/oidc - [`6873041`](https://github.com/hoppscotch/hoppscotch/commit/68730415ba573005b5c616e889dc60598624836e) chore: update pnpm-lock - [`057ecf9`](https://github.com/hoppscotch/hoppscotch/commit/057ecf94a975caa6ced20982d2ae8e3138ef907b) feat: proper support for OIDC scopes - [`5c57189`](https://github.com/hoppscotch/hoppscotch/commit/5c5718988d35e9d1a3e4574e9ae087c6b94be773) docs: adds OIDC to supported sign-in options - [`9717851`](https://github.com/hoppscotch/hoppscotch/commit/97178510d62e6e9f67bc25b603f3999ce1e3566c) chore: fix linter issue - [`61b2920`](https://github.com/hoppscotch/hoppscotch/commit/61b29203f565fdad5a8668ddc142823ffe3aaaf3) chore: adjust toast text ### 📊 Changes **49 files changed** (+399 additions, -16 deletions) <details> <summary>View changed files</summary> 📝 `.env.example` (+13 -0) 📝 `README.md` (+1 -0) 📝 `packages/hoppscotch-backend/package.json` (+2 -0) 📝 `packages/hoppscotch-backend/src/auth/auth.controller.ts` (+27 -0) 📝 `packages/hoppscotch-backend/src/auth/auth.module.ts` (+3 -0) ➕ `packages/hoppscotch-backend/src/auth/guards/oidc.guard.ts` (+33 -0) 📝 `packages/hoppscotch-backend/src/auth/helper.ts` (+1 -0) ➕ `packages/hoppscotch-backend/src/auth/strategies/oidc.strategy.ts` (+82 -0) ➕ `packages/hoppscotch-common/assets/icons/auth/oidc.svg` (+36 -0) 📝 `packages/hoppscotch-common/locales/af.json` (+1 -0) 📝 `packages/hoppscotch-common/locales/ar.json` (+1 -0) 📝 `packages/hoppscotch-common/locales/ca.json` (+1 -0) 📝 `packages/hoppscotch-common/locales/cn.json` (+1 -0) 📝 `packages/hoppscotch-common/locales/cs.json` (+1 -0) 📝 `packages/hoppscotch-common/locales/da.json` (+1 -0) 📝 `packages/hoppscotch-common/locales/de.json` (+1 -0) 📝 `packages/hoppscotch-common/locales/el.json` (+1 -0) 📝 `packages/hoppscotch-common/locales/en.json` (+1 -0) 📝 `packages/hoppscotch-common/locales/es.json` (+1 -0) 📝 `packages/hoppscotch-common/locales/fi.json` (+1 -0) _...and 29 more files_ </details> ### 📄 Description Closes #3001 ### Description The PR adds the option to configure your own OIDC client in the self-hosted version. It expands on top of the conditional auth provider implementations added in https://github.com/hoppscotch/hoppscotch/pull/3225 and https://github.com/hoppscotch/hoppscotch/pull/3204. To enable the OIDC sign in, you need to fill in the OIDC configuration options (client id, secret, and issuer endpoints) in `.env` and additionally enable the `OIDC` auth provider in `VITE_ALLOWED_AUTH_PROVIDERS`. You can also configure the login button text if you want to, e.g. `Login with COMPANY SSO`. ### Checks - [x] My pull request adheres to the code style of this project - [x] My code requires changes to the documentation - [ ] I have updated the documentation as required - [x] All the tests have passed ### Additional Information The implementation is tested with KeyCloak. I will provide setup documentation for both hoppscotch and different Identity providers in a second PR after this is merged. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>