Inhalt

Um das Servicekonto der BayernID anzubinden ist ein neuer Login Dienst anzulegen und als Authentifizierungstyp BayernID auszuwählen. 

Schritt 1: Konfiguration anlegen

Im 1. Schritt der Konfiguration erscheint eine Eingabeoberfläche, wo folgende Festlegungen getroffen werden müssen:

• Festlegung, ob Test- oder Live-Umgebung der BayernID anzubinden ist.
• Erhebung von Zertifikatsinformationen, welche anschließend zur Generierung eines privaten und öffentlichen Schlüssels herangezogen werden. Dieses Schlüsselpaar dient zur Ver- und Entschlüsselung der Kommunikation, zwischen Xima® formcycle und der BayernID.
• Angaben zum organisatorischen und technischen Ansprechpartner. Diese Informationen werden im Zuge des Registrierungsprozesses an das BayernID-Portal weitergegeben. 

Service Provider Entity ID

Die Service-Provider-Entity-ID dient der Identifizierung der Anfragen von formcycle im BayernID-Portal. Die ID wird in den Metadaten mit aufgenommen und zur Registrierung der BayernID an das BayernID-Portal gesendet. Bei späteren Anfragen von formcycle an das BayernID-Portal wird die ID abgeglichen und zugeordnet. Als formale Anforderungen muss die Service-Provider-Entity-ID als URL-Notation mit HTTPS angegeben werden und einen sprechenden Namen besitzen, indem z.B. der Name der Gemeinde/Stadt/Landkreises darin vorkommt. Die URL muss nicht erreichbar sein.

Die Service-Provider-Entity-ID wird bei der ersten Konfiguration als Auswahlmenü mit bekannten URLs von formcycle vorgegeben.

Anzeigename der Fachanwendung

Der Anzeigename der Fachanwendung wird dem Nutzer im BayernID-Portal angezeigt, bevor die Nutzerdaten an formcycle zurück übermittelt werden. Standardmäßig wird der Wert "XIMA FORMCYCLE" gesetzt. Ein Überschreiben des Wertes ist jederzeit möglich, wobei maximal 50 Zeichen für den neuen Namen erlaubt sind. Hier könnten Sie beispielweise Ihren Amtsnamen eintragen.

Der Anzeigename der Fachanwendung wird global in allen Formularen des Mandanten verwendet. Ab Version 2.3.0 des Bürgerservice-Plugins kann der Anzeigename auch direkt am Login-Button definiert werden. Dieser Wert überschreibt den globalen Anzeigenamen und ermöglicht die Angabe eines eigenen Namens für ein einzelnes Formular.

Nach dem Speichern der Eingaben gelangt man zum 2. Schritt der Anbindung.

Schritt 2: Metadaten erzeugen und registrieren

In diesem Schritt werden die SAML-Metadaten für die Registrierung auf Seiten der BayernID erzeugt. Dafür steht in der Oberfläche ein Button zur Verfügung. Im sich öffnenden Dialog sind alle im Xima® formcycle System gefundenen Host-Adressen, über die das System erreichbar ist, als Auswahlfeld aufgeführt.

Die Dialogoberfläche bietet auch die Möglichkeit einer freien Host-Adressen-Definition. Diese Möglichkeit kann dann genutzt werden, wenn bereits bekannt ist, wie die Formulare über das Internet erreichbar ist, der Host aber aktuell noch nicht im Netzwerk zur Verfügung steht und deshalb nicht automatisch ermittelt werden konnte.

Auf der Grundlage der jeweiligen ausgewählten Host-Adresse werden dann die Metadaten erzeugt und als Download zurück geliefert. Die jeweilige Host-Adresse bildet dabei einen Teil der Rücksprung-URL, welche später vom Identity Provider (BayernID Portal) zur Übermittlung der Authentifizierungsdaten genutzt wird.

Hinweis:
Nach dem Download der Metadaten sollte die Konfiguration gespeichert werden, damit die festgelegte Auswahl in der Datenbank gespeichert wird. Diese Auswahl bildet auch einen Teil der Daten für die Generierung der vorbefüllten Beitrittserklärung.

Weiterhin kann eine vorbefüllte Beitrittserklärung. Die Beitrittserklärung ist bereits mit den im vorherigen Schritt erhobenen Daten vorbefüllt und muss um die noch fehlenden Daten ergänzt werden.

Der Button zum Download wird erst verfügbar, wenn zuvor die Metadaten heruntergeladen und damit die verfügbaren Host-Adressen ausgewählt wurden.

Beitrittserklärung und SAML-Metadaten sind an das BayernID Portal (Mail: BayernID@akdb.de) zu senden, mit der Bitte, um Aufnahme in den Portalverbund.

Damit ist der 1. Teil der Registrierung abgeschlossen und eine Antwort vom BayernID Portal muss abgewartet werden.

Schritt 3: BayernID-Login Aktivierung

Dieser Schritt sollte erst durchgeführt werden, wenn Sie vom BayernID Portal Rückmeldung erhalten haben, dass ihre übermittelten Metadaten im Portal registriert und freigegeben sind. Erst mit dem Button BayernId-Login aktivieren wird der Authentikator im System aktiviert. Er ist damit in den Formularen verfügbar und kann eingebunden werden.

Hinweis:
Wenn Sie den Login vor einer positiven Rückmeldung des BayernID-Portals aktivieren,
so kann das die BayernID zwar bereits in den Formularen eingebunden werden,
wird aber beim Aufruf in einem Fehler resultieren.      

Nach Aktivierung des Logins erweitert sich die Konfigurationsoberfläche des Authentikators.

Optionale Limitierung erlaubter Origins

Bei Einbindung der Formulare innerhalb abweichender Domänen können hier die jeweiligen Origins nach dem Muster (https://www.xima.de) angegeben werden. Diese dienen zur Verifizierung der Anfragen innerhalb des Authentifizierungs-Workflows. Die durch das System zur Verfügung gestellten Mandant- und Frontend-Server-URLs müssen dabei nicht explizit angegeben werden.
Sind hier keine Werte definiert werden alle Origins zugelassen.

Konfiguration BayernID Postkorbanbindung

Unter dem Punkt Erweiterte Einstellungen > Konfigurtion BayernID Postkorbanbindung können Sie das Zertifikat, welches Sie im Zuge der Registrierung ihrer Metadaten vom BayernID Portal erhalten haben sollten, hochladen und zusammen mit dem zugehörigen Passwort an der Authentikator-Konfiguration abspeichern.

Über den Button Postkorb Verbindung prüfen kann der Zugriff auf den Postkorb-Webservice getestet werden.
Der Webservice muss dabei vom Xima® formcycle Master-Server aus erreichbar sein (dafür sind im System unter Umständen Firewall Freigaben notwendig).

Folgende URL muss vom formcycle Master-Server aus erreichbar sein:
Testsystem: https://infra-pre-id.bayernportal.de/bspx-postkorb-okkomm-ws/bspservices/postkorbkomm							
ODER
Livesystem: https://id.bayernportal.de/bspx-postkorb-okkomm-ws/bspservices/postkorbkomm

Fehlerbehebung, wenn die Prüfung des Postkorbverbindung fehl schlägt:
Prüfen Sie, ob die Freischaltung in der Firewall erfolgt ist.
Der Postkorb-Webservice nutzt das HTTPS Protokoll für die Kommunikation, welches im Transport-Layer das TCP Protokoll benutzt. Deshalb sollte in ihrer Firewall die IP 193.28.249.234 (für das Livesystem id.bayernportal.de) oder IP 193.28.249.228 (für das Testsystem infra-pre-id.bayernportal.de) als TCP-Verbindungen der Port 443 (das ist der Standard-Https-Port) sowohl für die ausgehende als auch eingehende Kommunikation freigegeben sein.      

Folgende zusätzliche Einstellungen für die Verbindung zum Postkorb-Service können konfiguriert: