Zum Inhalt springen

Identity-Provider-Vorlagen

Jeder Single-Sign-On-Provider entsteht aus einer Vorlage. Eine Vorlage beschreibt einen Identity Provider: Name und Symbol, die Adresse des Anbieters, wie sich ReadyStackGo dort registriert und welche Claims Benutzername, Anzeigename und E-Mail liefern. Alles Weitere liest der Einrichtungslauf unter Settings → Single Sign-On aus der Vorlage.

IdNameAdresse des AnbietersRegistrierung
wyschWYSCHhttps://id.wysch.wiesenwischer.de/ (fest)pairing: bei WYSCH verbinden und bestätigen, nichts abtippen
generic-oidcGeneric OIDCvom Nutzer eingegebenmanual: Client-ID und Secret werden eingetragen

wysch wird zusätzlich im ersten Schritt des Setup-Wizards angeboten.

Eine Vorlage ist ein Ordner <id>/ mit template.json und optional icon.svg:

identity-provider-templates/
└── company-sso/
├── template.json
└── icon.svg
{
"id": "company-sso",
"name": "Company SSO",
"description": "Sign in with your company account.",
"setupDescription": "Sign in with your company account.",
"order": 20,
"provider": { "name": "company", "displayName": "Company SSO" },
"authority": { "url": "https://login.example.com/realms/main" },
"registration": { "kind": "manual" },
"requirePar": false,
"requireHttps": false,
"scopes": "openid profile email",
"claims": { "username": "preferred_username", "displayName": "name", "email": "email" },
"helpUrl": "https://intranet.example.com/sso",
"offerInSetup": false
}
FeldPflichtBedeutung
idjaKleinbuchstaben, Ziffern und Bindestriche (1–40), gleich dem Ordnernamen
namejaName der Kachel und der Vorlage
description, setupDescriptionneinText der Kachel in den Settings und im Setup-Wizard (Letzterer fällt auf den ersten zurück)
orderneinReihenfolge (kleiner zuerst)
provider.nameneinVorgeschlagener Provider-Name, Teil der Redirect-URI; Standard ist die Id
provider.displayNameneinVorgeschlagener Anzeigename
authority.url oder authority.inputja, genau einsFeste Adresse des Anbieters oder { "hint", "example" } für eine Adresse, die der Nutzer eingibt
registration.kindjamanual oder pairing
requireParneinImmer Pushed Authorization Requests (RFC 9126) nutzen
requireHttpsneinDie Installation muss HTTPS nutzen (http nur auf localhost)
scopesneinMuss openid enthalten; Standard openid profile email
claimsneinClaim-Namen für Benutzername, Anzeigename und E-Mail
helpUrlneinLink zu weiterer Hilfe
offerInSetupneinAls Kachel im ersten Wizard-Schritt anbieten (Registrierung muss pairing und die Adresse fest sein)

icon.svg ist ein SVG mit höchstens 64 KB. Es wird mit einer abschottenden Content Security Policy ausgeliefert und nur als Bild angezeigt. Vorlagen ohne Symbol zeigen einen Schlüssel.

Ein Provider behält die Einstellungen seiner Vorlage ab dem Anlegen: Ändert sich eine Vorlage später oder verschwindet sie, arbeiten bestehende Provider weiter.

Binden Sie ein Verzeichnis nach /app/identity-provider-templates ein:

services:
readystackgo:
volumes:
- ./identity-provider-templates:/app/identity-provider-templates:ro
environment:
- IdentityProviderTemplates__Enabled=wysch,company-sso
  • Eine Vorlage im Verzeichnis ersetzt eine eingebaute mit derselben Id.
  • IdentityProviderTemplates__Enabled schränkt die angebotenen Vorlagen ein (durch Kommas getrennt, leer bietet alle an).
  • IdentityProviderTemplates__Path ändert das Verzeichnis.
  • Ungültige Vorlagen werden mit einer Warnung im Log übersprungen. Änderungen erscheinen nach spätestens 30 Sekunden.