Skip to content

Add backend-only OIDC login documentation #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions docs/development/backend/oidc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
This backend-only implementation adds OpenID Connect (OIDC) login via Google, GitHub, and Microsoft using [Authlib](https://docs.authlib.org).

## Features
Role-based login with Google, GitHub, Microsoft
Backend-only logic (no frontend UI changes)
Session-based user info (not persisted in DB)

## Setup Instructions

1. Install dependencies

```bash
pip install Authlib python-dotenv
```

1. Copy and fill your .env file

```bash
cp .env.example .env
```
3. Update .env with your OIDC client IDs and secrets

4. Run the app

```bash
flask run
```
5. Login

Visit:
http://localhost:5000/auth/login/google


http://localhost:5000/auth/login/github


http://localhost:5000/auth/login/microsoft


## File Structure

.env.example
auth/
└── oidc.py # OIDC logic
gramps_webapi/
└── app.py # Registers blueprint and OAuth setup

## Test
After login, you’ll be redirected back and shown user info. Session storage is temporary and can be extended for persistence.