MyQ X Server
10.3 10.2 8.2 EoL Print Server Central Server English French German Italian Portuguese Spanish
10.3 10.2 8.2 EoL Print Server Central Server English French German Italian Portuguese Spanish

Externe Authentifizierung über API-Konnektor

Diese Seite behandelt die Authentifizierung von Ausweisen oder PINs über einen benutzerdefinierten Dienst mittels API. Dies ist nützlich, wenn Ihr Authentifizierungsdienst von MyQ nicht nativ unterstützt wird. Informationen zur Authentifizierung von Benutzerdaten gegenüber LDAP- oder RADIUS-Servern finden Sie unter Benutzer über LDAP oder RADIUS authentifizieren.

Die externe Authentifizierung wird für die Anmeldung am MyQ Embedded Terminal und am MyQ Desktop Client verwendet. Die MyQ-Weboberfläche und der MyQ X Mobile Client erfordern Anmeldedaten, die in MyQ festgelegt wurden.


So funktioniert es

Es wird eine API-Verbindung zwischen MyQ und dem Authentifizierungsdienst eingerichtet. MyQ fordert über diese Verbindung die Authentifizierung an; auf der anderen Seite befindet sich der Authentifizierungsdienst selbst, in dem die Benutzer und ihre Anmeldedaten gespeichert sind.

  1. Der Benutzer versucht, sich auf dem MyQ Embedded Terminal mit einer der folgenden Methoden anzumelden:

    • Durch Durchziehen ihrer ID-Karte

    • Eingabe der PIN

  2. Die Anfrage wird an den API-Konnektor gesendet und enthält den Typ der Anmeldemethode sowie den entsprechenden Wert.

  3. Der Konnektor übernimmt die Kommunikation mit dem Authentifizierungsdienst und gibt den passenden Benutzer an MyQ zurück.

Für die externe Authentifizierung gibt es zwei Betriebsmodi. Entweder kann sie als primäre Methode zur Authentifizierung von Benutzern dienen oder als Backup-Authentifizierung konfiguriert werden, falls die Authentifizierung gegenüber der MyQ-Datenbank fehlschlägt. Hierfür kann die Option Nur verwenden, wenn die Authentifizierung gegenüber der MyQ-Datenbank fehlschlägt ausgewählt werden.


Authentifizierungsanfrage

Unterstützte Anmeldemethoden

Diese Einstellung legt die Anmeldemethode fest, für die die externe Authentifizierung verwendet wird. Die andere, nicht ausgewählte Anmeldemethode authentifiziert den Benutzer anhand der Anmeldedaten in MyQ.

  • ID-Karte

  • PIN

MyQ übermittelt den Typ der Anmeldemethode zusammen mit dem tatsächlichen PIN-/Ausweiswert, damit der API-Konnektor erkennen kann, welche Benutzereigenschaft verwendet werden muss, um den richtigen Benutzer zu finden.

Wird beispielsweise eine ID-Karte ausgewählt und authentifiziert sich der Benutzer am Embedded Terminal mit einer ID-Karte, sendet MyQ loginType=1&loginValue=1234 aus. Dies kann als die ID-Kartennummer 1234 interpretiert werden.

Ist ein Kartenlesegerät, das Tastatureingaben emuliert, an das Gerät angeschlossen und zieht ein Benutzer seine Karte durch, kann MyQ nicht erkennen, ob es sich bei dem empfangenen Wert um eine PIN oder eine Ausweisnummer handelt. MyQ teilt dies dem API-Konnektor mit (loginType=7). Der Konnektor sollte so konfiguriert werden, dass er diese Anfragen verarbeitet, z. B. indem er versucht, die Authentifizierung anhand beider Benutzerattribute durchzuführen.

Authentifizierungsantwort

Unterstützte Benutzerkennungen

Der API-Konnektor muss im JSON-Format mit einem der Werte an MyQ zurückmelden, um den richtigen Benutzer zuzuordnen und ihn beim Client anzumelden.

  • Persönliche Nummer eines bestehenden Benutzers in MyQ

  • Benutzername eines bestehenden Benutzers in MyQ

Beispielantworten:

  • {"result":0,"personalNumber":"123456"} bedeutet, dass der Benutzer vom Authentifizierungsdienst erfolgreich identifiziert wurde und seine persönliche Nummer 123456 lautet. Der Benutzer mit dieser persönlichen Nummer in MyQ ist authentifiziert.

  • {"result":0,"username":"JohnDoe"} bedeutet, dass der Benutzer identifiziert wurde und sein Benutzername JohnDoe lautet. Der Benutzer mit diesem Benutzernamen in MyQ ist authentifiziert.

Fehlerzustände

  • Ungültiger Benutzer ({"result":1}) – Der Benutzer wurde gefunden, sein Konto ist jedoch ungültig (z. B. deaktiviert)

  • Kein Benutzer gefunden ({"result":2}) – es gibt keinen Benutzer, der mit den Anmeldedaten verknüpft ist

Häufige Anwendungsfälle

Der External-API-Konnektor kann in seiner einfachsten Form zum Übersetzen von Anfragen verwendet werden. Er ermöglicht jedoch auch komplexere Authentifizierungsabläufe, da der Konnektor selbst eine Reihe von Operationen ausführen kann, bevor er den passenden Benutzer an MyQ zurückgibt.

Beispiel 1: Es wird ein von MyQ nicht unterstützter Authentifizierungsdienst benötigt

Ein Konnektor, der die API-Aufrufe zwischen MyQ und dem externen Authentifizierungsdienst übersetzt.

Beispiel 2: Erweiterter Authentifizierungsablauf – mehrere Identitäten

Die externe Authentifizierung kann in Fällen genutzt werden, in denen ein Vorgang zwischen MyQ und dem Authentifizierungsserver stattfinden muss. Dies kann eine Transformation, eine erweiterte Benutzererkennung in Umgebungen mit mehreren Domänen und vieles mehr sein.

Einrichtung der externen Authentifizierung

Das Ziel Externe Authentifizierung kann unter MyQ > Einstellungen > Benutzerauthentifizierung aktiviert und konfiguriert werden.

users-settings-authentication-external.png
  • URL: Geben Sie die URL ein, unter der der API-Konnektor ausgeführt wird

  • Benutzername: Geben Sie den Benutzernamen ein, der für die Verbindung zum externen Server über die API erforderlich ist

  • Passwort: Geben Sie das Passwort ein, das für die Verbindung zum externen Server über die API erforderlich ist

  • Anmeldemethode: Wählen Sie die Anmeldemethode für den Benutzer aus – ID-Karte oder PIN

  • Nur verwenden, wenn die Authentifizierung gegenüber der MyQ-Datenbank fehlschlägt: Diese Option legt fest, ob die externe Authentifizierung als primäre oder sekundäre Authentifizierungsmethode dient

    • Ist diese Option aktiviert, wird der Benutzer zunächst gegenüber dem MyQ Print Server authentifiziert; erst wenn dies fehlschlägt, erfolgt der nächste Versuch über den Remote-Authentifizierungsdienst

    • Ist diese Option deaktiviert, findet keine Authentifizierung gegenüber dem MyQ Print Server statt; es wird stets der externe Authentifizierungsdienst verwendet