OIDC SPA
GitHubHome
v3
  • Documentation
  • Release Notes & Upgrade Instructions
v3
  • Getting started
    • ⭐Overview
    • 🔩Installation
    • 👨‍🔧Usage
    • 🔑Usage with Keycloak
  • Example setups
    • React Router
    • Tanstack Router
  • API Reference
    • 🍦Vanilla API
      • createOidc()
    • ⚛️React API
      • createOidcProvider
      • createUseOidc
Powered by GitBook
On this page
  • Compared to alternatives
  • Notable project using the library

Was this helpful?

Export as PDF
  1. Getting started

Overview

A solution to implement user authentication in your webapplication

NextInstallation

Last updated 1 year ago

Was this helpful?

An OIDC client tailored for Single Page Applications, particularly suitable for projects. This library is intended for scenarios such as integrating your application with .

In straightforward terms, this library is ideal for those seeking to enable user login/registration in their web application. When used in conjunction with Keycloak (for example), it enables you to offer a modern and secure authentication experience with minimal coding effort. This includes options for signing in via Google, X, GitHub, or other social media platforms. We provide comprehensive guidance from beginning to end.

  • 🎓 Accessible to all skill levels; no need to be an OIDC expert.

  • 🛠️ Easy to set up; eliminates the need for creating special /login /logout routes.

  • 🎛️ Minimal API surface for ease of use.

  • ✨ Robust yet optional React integration.

  • 📖 Comprehensive documentation and project examples: End-to-end solutions for authenticating your app.

  • ✅ Best in class type safety: Enhanced API response types based on usage context.

Compared to alternatives

While oidc-client-ts serves as a comprehensive toolkit, our library aims to provide a simplified, ready-to-use adapter that will pass any security audit and that will just work out of the box on any browser. We utilize oidc-client-ts internally but abstract away most of its intricacies.

Our library takes a modular approach to OIDC and React, treating them as separate concerns that don't necessarily have to be intertwined. At its core, oidc-spa is a straightforward adapter that isn't tied to any specific UI framework, making it suitable for projects that enforce a strict separation of concerns between the core logic of the application and the UI. Additionally, we provide adapters for React and starter projects for integration with react-router-dom or @tanstack/react-router.

Beside the fact that this lib only works with Keycloak .

Notable project using the library

Onyxia:

The French Interministerial Base of Free Software:

⭐
Vite
Keycloak
oidc-client-ts
react-oidc-context
keycloak-js
it is also likely to be deprecated
Source code
Public instance
Source code
Deployment of the website