In den letzten Wochen haben wir gezeigt, wie verschiedene Endpunkte der OneSpan Intelligent Adaptive Authentication (IAA) über die Interactive Sandbox-API genutzt werden können. Im Blog dieser Woche setzen wir die laufende Serie fort und erklären, wie Sie den Aktivierungsstatus eines neuen Benutzers bei der Registrierung überprüfen können. Zu diesem Zweck verwenden wir den Endpunkt "/registrations/check-status" im Open API Swagger-Editor.

Bevor wir beginnen:

Bevor Sie den Webservice "/registrations/check-status" erkunden können, müssen Sie zunächst ein OneSpan-Community-Mitglied sein und sich für ein kostenloses Intelligent Adaptive Authentication-Sandbox-Konto anmelden. Hier finden Sie eine Schritt-für-Schritt-Anleitung, wie Sie dies tun.

Sie sollten auch sicher sein, dass mindestens ein registrierter Benutzer vorhanden ist, bevor Sie diesen Aufruf versuchen. Wie Sie einen Benutzer registrieren können, erfahren Sie in diesem ausführlichen Blog zur Benutzerregistrierung.

Einführung

Mit dem Endpunkt "/registrations/check-status" können Sie den aktuellen Aktivierungsstatus des vertrauenswürdigen Geräts eines neuen Benutzers überprüfen. Dies gibt Ihnen einen Hinweis darauf, ob das in Ihre Anwendung integrierte Orchestration SDK seine Aktivierung auf dem vertrauenswürdigen Gerät abgeschlossen hat oder ob weitere Aktionen erforderlich sind, um den Aktivierungsprozess abzuschließen. Wenn wir in diesem Tutorial fortfahren, werden Sie feststellen, dass der "check-status"-Endpunkt relativ einfach zu nutzen und daher leicht in Ihre Lösung zu integrieren ist.

Navigieren Sie zu Check-Status Endpoint:

Um mit dem "check-status"-Endpunkt zu experimentieren, navigieren Sie zur IAA Sandbox Interactive API Ihres OneSpan Community-Kontos. Erweitern Sie im Open API Swagger-Editor die Ressource "Provisioning". Sie finden dann einen Eintrag für die HTTP-Post-Methode "check-status", wie in der folgenden Abbildung dargestellt.

Check-Status Endpunkt URL

Die Anfrage-URL für diesen API-Aufruf wird der folgenden URL ähneln:

https:// {Ihre_Mieter_ID}.sdb.tid.onespan.cloud/v1/registrierungen/check-status

Sie müssen diese URL während des Tutorials nicht angeben. Sie dient nur dazu, die Struktur der URL zu zeigen. Die URL wird in der Interaktiven API beim Aufruf des Webdienstes automatisch zugewiesen

Aktivierungsstatus in Aktion prüfen

Registrieren eines Benutzers

Für den Zweck des Beispiels müssen wir ein neues Benutzerkonto registrieren und dann den Status seiner Aktivierung überprüfen. Eine vollständige Erklärung, wie Sie einen Benutzer registrieren, finden Sie im Blog "OneSpan Developer: Intelligent Adaptive Authentication - User Registration".

Nach einer erfolgreichen Registrierung erhalten Sie einen 200-OK Response Status Code, der die erfolgreiche Registrierung des Benutzers anzeigt. Von dort aus werden wir mit dem Beispiel fortfahren und den Aktivierungsstatus des Benutzers auf dem vertrauenswürdigen Gerät überprüfen.

Check-Status-Anfragekörper

Der Anfragekörper des Check-Status-Endpunktaufrufs enthält drei JSON-Objekte. Nur das Feld "Login" ist obligatorisch, während die anderen beiden optional sind. Die Feldbeschreibungen finden Sie in der folgenden Tabelle:

JSON-Datenfelder	Beschreibung	Feld Datentyp
anmeldung*	Kennung für den Benutzer, für den eine Aktivierungsprüfung durchgeführt werden soll.	Typ: string minLength: 1 maxLength: 255 Beispiel: iaa_user
domain	Domäne, in der sich das Benutzerkonto befindet.	Typ: string minLength: 1 maxLength: 255 Beispiel: ospanuser-mail
timeoutSekunden	Die Zeit, nach der die Anfrage für den synchronen Aufruf des Endpunkts ausläuft, wenn dieses Feld nicht angegeben wird, wird der Endpunkt automatisch asynchron aufgerufen.	Typ: Ganzzahl Beispiel: 10

 

Der JSON-formatierte Anfragekörper des Endpunkts "registrations/check-status" sieht wie das folgende Beispiel aus

 
{ "login": "userid1", "Domain": "ospanuser-mail", "timeoutSeconds": 10 }

Synchron vs. Asynchron

Die Überprüfung des Aktivierungsstatus kann entweder ssynchron oder asynchron erfolgen. Wenn synchron, ist das Feld "timeoutSeconds" erforderlich. Wenn angegeben, ist der Aufruf des Check-Status-Endpunkts automatisch synchron. Das heißt, die Überprüfung des Aktivierungsstatus wird innerhalb der in Sekunden angegebenen Zeitdauer fortgesetzt. Bei einer asynchronen Methode prüft der Endpunkt den Status der Aktivierung sofort beim Aufruf. Für einen asynchronen Aufruf muss das Feld "timeoutSeconds" in der Request-Payload des "check-status"-Endpunkts weggelassen werden. Dadurch unterscheidet sich der Aufruf für die beiden Mechanismen

Aufrufen des Check-Status-Endpunkts:

Jetzt ist es an der Zeit, den Aktivierungsstatus des neuen Benutzers für OneSpan IAA zu überprüfen. Um den API-Aufruf durchzuführen, klicken Sie auf die Schaltfläche "Try it out", die im Screenshot unten gezeigt wird, auf der rechten Seite des Post-Methoden-Abschnitts "registrations/check-status". Nach der Anfrage erhalten Sie den Antwortkörper in einem JSON-Format zurück. Sie ähnelt der Antwort-Payload, die im folgenden Abschnitt beschrieben wird.

Aktivierungsstatus API-Aufruf Antwortkörper:

Nachfolgend sehen Sie ein Beispiel für einen zurückgegebenen Antwortkörper des API-Aufrufs "registrations/check-status".

 
{ "activationStatus": "pending" }

 

Aktivierungsstatus-Typen

Das einzige zurückgegebene Feld in der Antwort-Payload ist "activationStatus". Sie ist vom Typ String und ihr Wert ist einer der unten aufgeführten Geräteaktivierungszustände:

Aktivierungsstatus Typ	Bedeutung
unbekannt	Keine ausstehende Aktivierung für den im Request-Payload-Feld "login" angegebenen Benutzer gefunden.
anhängig	Der Aktivierungsprozess für das im Request-Payload-Feld "login" angegebene Benutzerkonto ist in Bearbeitung.
aktiviert	Der Aktivierungsprozess wurde auf dem vertrauenswürdigen Gerät des Benutzerkontos abgeschlossen, das im Feld "login" des Request Payloads angegeben ist.
timeout	Der Aktivierungsvorgang wurde zeitlich begrenzt, bevor die Aktivierung abgeschlossen war.

 

Nach der Registrierung wird der Aktivierungsstatus als "Ausstehend" angezeigt, bis der Benutzer die Aktivierung abgeschlossen hat. Wenn die Aktivierung nicht innerhalb von 10 Minuten erfolgt ist, läuft die Sitzung ab und der Aktivierungsstatus ändert sich in "Unbekannt".

In diesem Blog haben wir gezeigt, wie Sie den Aktivierungsstatus eines Endbenutzerkontos mithilfe des Check-Status-Endpunkts der interaktiven API der IAA-Sandbox überprüfen können. Inzwischen sollten Sie das Wissen haben, es zu benutzen und es in Ihre Lösung zu integrieren. Wenn Sie Fragen haben, können Sie uns in den OneSpan Community Portal-Forenerreichen .