# Single Sign-On in Procurat!5 einrichten

<p class="callout warning">Derzeit wird nur Keycloak als OAuth2-Provider unterstützt</p>

### Vorbereitungen

Um Procurat!5 mit Single Sign-On (im nachfolgenden SSO genannt) einrichten zu können, benötigen Sie folgende Informationen

- URL der Procurat-Installation (z.B [https://procurat.musterschule.de/procurat](https://procurat.musterschule.de/proczrat))
- Einen eingerichteten Client in Keycloak. Procurat benötigt hier lediglich den Scope `openid`, da die Zuordnung der Benutzer über das `sub` Feld des ID-Tokens erfolgt

### Konfigurationen erstellen

<p class="callout info">Am einfachsten kann die nötige Konfiguration mit [diesem Script](https://docs.alpha-np.de/attachments/7) erstellt werden</p>

Die Konfiguration der verschiedenen Provider erfolgt in Procurat mithilfe eines JSON-Strings. Am einfachsten kann eine korrekte Konfiguration mit dem oben aufgeführten Skript erstellt werden:

##### Schritt 1: Keycloak Provider hinzufügen

Wählen Sie `1` um einen neuen Keycloak-Provider hinzuzufügen

[![Screenshot 2025-11-20 at 16.56.59.png](https://docs.alpha-np.de/uploads/images/gallery/2025-11/scaled-1680-/screenshot-2025-11-20-at-16-56-59.png)](https://docs.alpha-np.de/uploads/images/gallery/2025-11/screenshot-2025-11-20-at-16-56-59.png)

##### Schritt 2: Ausfüllen der Informationen

Sie werden nun in verschiedenen Schritten nach der Keycloak-Konfiguration gefragt - folgende Informationen sind relevant:

<table border="1" id="bkmrk-name-ein-einzigartig" style="border-collapse: collapse; width: 100%; height: 258.969px;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr style="height: 46.5938px;"><td style="height: 46.5938px;">Name</td><td style="height: 46.5938px;">Ein einzigartiger (interner) des Providersz.B keycloak-procurat</td></tr><tr style="height: 46.5938px;"><td style="height: 46.5938px;">Display Name</td><td style="height: 46.5938px;">Der Anzeigename des Providers - dieser erscheint auf der Anmeldeseite als "Anmelden mit {DisplayName}"</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">Base URL</td><td style="height: 29.7969px;">Die URL der Keycloak-Installation</td></tr><tr style="height: 46.5938px;"><td style="height: 46.5938px;">Realm</td><td style="height: 46.5938px;">Der Realm, welchen Sie für die Anmeldung in Procurat nutzen möchten</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">Client ID</td><td style="height: 29.7969px;">Die Client-ID des Procurat-OAuth-Clients in Keycloak</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">Client Secret</td><td style="height: 29.7969px;">Das Client-Secret des Procurat-OAuth-Clients in Keycloak</td></tr></tbody></table>

[![Screenshot 2025-11-20 at 16.58.37.png](https://docs.alpha-np.de/uploads/images/gallery/2025-11/scaled-1680-/screenshot-2025-11-20-at-16-58-37.png)](https://docs.alpha-np.de/uploads/images/gallery/2025-11/screenshot-2025-11-20-at-16-58-37.png)


##### Schritt 3: Abschließen der Konfiguration

Nachdem Sie die erforderlichen Informationen ausgefüllt haben, haben Sie die Möglichkeit, entweder eine weitere Konfiguration hinzuzufügen, oder die Konfiguration abzuschließen um den Wert für die Procurat-Einstellungen zu erhalten. Wählen Sie `0` um die Konfiguration abzuschließen:

[![Screenshot 2025-11-20 at 17.04.13.png](https://docs.alpha-np.de/uploads/images/gallery/2025-11/scaled-1680-/screenshot-2025-11-20-at-17-04-13.png)](https://docs.alpha-np.de/uploads/images/gallery/2025-11/screenshot-2025-11-20-at-17-04-13.png)

Kopieren Sie den angezeigten JSON-String, dieser wird im nächsten Schritt benötigt

### Einstellungen in Procurat!5

##### Schritt 1: Öffnen der Einstellungen

Öffnen Sie die Einstellungen als administrativer Benutzer. Navigieren Sie hierfür nach der Anmeldung zu Administration -&gt; Reiter Einstellungen -&gt; Einstellungen

[![Screenshot 2025-11-20 at 17.07.12.png](https://docs.alpha-np.de/uploads/images/gallery/2025-11/scaled-1680-/screenshot-2025-11-20-at-17-07-12.png)](https://docs.alpha-np.de/uploads/images/gallery/2025-11/screenshot-2025-11-20-at-17-07-12.png)

##### Schritt 2: Hinzufügen / Überprüfen der "ProcuratUrl" Einstellung

Fügen Sie einen neuen Wert (bzw. überprüfen Sie den eventuell bereits vorhandenen) für "ProcuratUrl" hinzu. Diese URL muss mit der URL der Procurat-Installation übereinstimmen

<table border="1" id="bkmrk-gruppe-zentrale-name" style="border-collapse: collapse; width: 100%; height: 135.984px;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**Gruppe**  
</td><td style="height: 29.7969px;">Zentrale</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**Name**</td><td style="height: 29.7969px;">ProcuratUrl</td></tr><tr><td>**Type**</td><td>String</td></tr><tr style="height: 46.5938px;"><td style="height: 46.5938px;">**StringValue**  
</td><td style="height: 46.5938px;">Die Procurat-URL Ihrer Installation (z.B https://procurat.musterschule.de/procurat)</td></tr></tbody></table>

[![Screenshot 2025-11-20 at 17.10.11.png](https://docs.alpha-np.de/uploads/images/gallery/2025-11/scaled-1680-/pB1screenshot-2025-11-20-at-17-10-11.png)](https://docs.alpha-np.de/uploads/images/gallery/2025-11/pB1screenshot-2025-11-20-at-17-10-11.png)

##### Schritt 3: Hinzufügen / Überprüfen der "OAuth" Einstellung

Fügen Sie einen neuen Wert (bzw. überprüfen Sie den eventuell bereits vorhandenen) für "OAuth" hinzu. Dies ist der Wert, der zuvor mithilfe des Scripts generiert wurde

<table border="1" id="bkmrk-gruppe-zentrale-name-1" style="border-collapse: collapse; width: 100%; height: 135.984px;"><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**Gruppe**  
</td><td style="height: 29.7969px;">Zentrale</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**Name**</td><td style="height: 29.7969px;">OAuth</td></tr><tr><td>**Type**</td><td>String</td></tr><tr style="height: 46.5938px;"><td style="height: 46.5938px;">**StringValue**  
</td><td style="height: 46.5938px;">Der zuvor generierte JSON-Wert

</td></tr></tbody></table>

[![Screenshot 2025-11-20 at 17.16.04.png](https://docs.alpha-np.de/uploads/images/gallery/2025-11/scaled-1680-/screenshot-2025-11-20-at-17-16-04.png)](https://docs.alpha-np.de/uploads/images/gallery/2025-11/screenshot-2025-11-20-at-17-16-04.png)

##### Schritt 4: Konfigurieren der Benutzer

Damit die Zuordnung der Procurat-Benutzer zu den Benutzern im OAuth-Provider korrekt funktioniert, muss jedem Benutzer, welcher sich mit dem Provider anmelden soll, ein Provider (der von Ihnen gewählte Name) sowie die externe ID (z.B die Benutzer-ID in Keycloak) zugewiesen werden. Diese Einstellung wird in Administration -&gt; Rechte -&gt; Benutzer konfiguriert

[![Screenshot 2025-11-20 at 17.19.07.png](https://docs.alpha-np.de/uploads/images/gallery/2025-11/scaled-1680-/screenshot-2025-11-20-at-17-19-07.png)](https://docs.alpha-np.de/uploads/images/gallery/2025-11/screenshot-2025-11-20-at-17-19-07.png)

Hier müssen folgende Einstellungen konfiguriert werden

<table border="1" id="bkmrk-oauthprovider-der-na" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 50%;"></col><col style="width: 50%;"></col></colgroup><tbody><tr><td>**OAuthProvider**  
</td><td>Der Name des Providers (z.B my-sso in dem Konfigurationsbeispiel)</td></tr><tr><td>**OAuthID**  
</td><td>Die ID des Benutzers im OAuth Provider</td></tr></tbody></table>

### Überprüfen der Einstellungen

<p class="callout success">Die Konfiguration der OAuth-Anmeldung ist nun abgeschlossen. Nach der Abmeldung sollten Sie die entsprechenden Buttons zur Anmeldung mit den konfigurierten Providern im Anmeldebildschirm sehen:</p>

[![Screenshot 2025-11-20 at 17.20.52.png](https://docs.alpha-np.de/uploads/images/gallery/2025-11/scaled-1680-/screenshot-2025-11-20-at-17-20-52.png)](https://docs.alpha-np.de/uploads/images/gallery/2025-11/screenshot-2025-11-20-at-17-20-52.png)