From ffcbbf6292abeafbd5fdc5dbc4693cfbd8ac429c Mon Sep 17 00:00:00 2001 From: Senior Data Engineer Date: Tue, 1 Sep 2026 07:59:08 -0400 Subject: [PATCH] Clarify SSO setup via Database Admin interface (#12474) * Clarify SSO setup via Database Admin interface Fixes #10415 by documenting that Social applications are configured in Django admin at /admin/, not via config.yaml or API. * docs: move Database Admin access details to db_admin.md Per review: drop the access-how-to from SSO.md and link to the Database Admin guide instead. --------- Co-authored-by: Matthias Mair --- docs/docs/settings/SSO.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/docs/settings/SSO.md b/docs/docs/settings/SSO.md index 611df18685..4540551fc8 100644 --- a/docs/docs/settings/SSO.md +++ b/docs/docs/settings/SSO.md @@ -18,11 +18,14 @@ The basic requirements for configuring SSO are outlined below: 1. Enable backend for each required SSO provider(s) in the [config file or environment variables](../start/config.md#single-sign-on). 1. Create an external *app* with your provider of choice -1. Add the required client configurations in the `SocialApp` app in the [Database Admin interface](../settings/db_admin.md). +1. Add the required client configurations as a *Social application* in the [Database Admin interface](./db_admin.md). 1. Configure the *callback* URL for the external app. 1. Enable SSO for the users in the [global settings](../settings/global.md). 1. Configure [e-mail](../settings/email.md). +!!! info "Two-step setup" + Provider modules are enabled in `config.yaml` (or environment variables). Client IDs, secrets, and site assignments are **not** configured there — they must be added as *Social applications* in the [Database Admin interface](./db_admin.md). SSO providers cannot be configured via the InvenTree API. + ### Enable Provider Backends The first step is to ensure that the required provider modules are installed, via your installation [configuration file](../start/config.md#single-sign-on). @@ -61,13 +64,13 @@ In general, the external app will generate a *key* and *secret* pair - although ### Add Client Configurations -Once your external SSO app has been created, you need to create a new *SocialAccount* client configuration (via the InvenTree admin interface). +Once your external SSO app has been created, you need to create a new *Social application* entry in the [Database Admin interface](./db_admin.md) (under **Social accounts** → **Social applications** — not in the Admin Center). #### Create Social Application -In the admin interface, select *Add Social Application* +Select **Add social application** (top right of the social applications list). Social applications are listed under the **Social accounts** section of the Database Admin — not in the InvenTree Admin Center settings screens. -{{ image("settings/social_account_add.png", "Add Social Application") }} +{{ image("settings/social_account_add.png", "Database Admin — Social applications section") }} #### Configure Social Application