OneSpan Developer: Intelligente adaptive Authentifizierung - Benutzerabfrage am Endpunkt

OneSpan Intelligent Adaptive Authentication (IAA ) bietet eine einfache Möglichkeit, die Benutzer aufzulisten, die für eine bestimmte Domain registriert wurden. Mit dem Endpunkt "User Query" (Benutzerabfrage) können Sie einen Einblick in jeden Ihrer aktuell registrierten Benutzer innerhalb Ihres Sandbox-Kontos erhalten. Es gibt verschiedene Parameter, mit denen Sie bequem nur bestimmte Benutzer abfragen oder durch mehrere Instanzen paginieren können. In diesem Blog werfen wir einen Blick auf den Benutzerabfrage-Endpunkt, seine Pfadparameteroptionen und wie Sie ihn über die interaktive API der IAA-Sandbox testen können.

Bevor wir beginnen: Werden Sie Mitglied der OneSpan-Entwicklergemeinschaft

Bevor Sie den Webservice für Benutzerabfragen erkunden können, müssen Sie zunächst Mitglied der OneSpan-Community sein und sich für ein kostenloses Sandbox-Konto für die intelligente adaptive Authentifizierung 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.

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 OneSpan Developer: Intelligent Adaptive Authentication - User Registration.

Endpunkt-URL

Die Anfrage-URL für diesen API-Aufruf wird dem unten stehenden Beispiel ähneln:

https://{Ihre_Mieter_ID}.sdb.tid.onespan.cloud/v1/users

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 Webservice automatisch zugewiesen

Probieren Sie es mit dem interaktiven API-Doku

Um mit der Benutzerabfrage-API zu experimentieren, navigieren Sie zum IAA Sandbox Interactive API-Dokument Ihres OneSpan Community-Kontos. Erweitern Sie im Open API Swagger-Editor die Ressource "Benutzer". Sie finden dann einen Eintrag für die HTTP-Get-Methode "Users Query" wie in der folgenden Abbildung

Die Benutzerabfrage-API ist recht einfach zu bedienen. Es ist nicht erforderlich, einen JSON-Anfragekörper für den Aufruf der HTTP-GET-Methode bereitzustellen. Sie müssen lediglich die unten erläuterten Pfadparameter einrichten, um den Aufruf für bestimmte Ergebnisse anzupassen.

URL-Parameter

Die folgende Tabelle zeigt die verschiedenen Pfadparameter-Optionen, die zum Anpassen der Abfrage innerhalb der Sandbox Platform API verwendet werden. Es enthält auch eine Beschreibung und ein Beispiel für jeden Pfadparameter, damit Sie den Endpunkt der Benutzerabfrage optimal nutzen können.

Parameter	Beschreibung	Feld Datentyp
userID	Benutzer-ID des Benutzers, nach dem gesucht werden soll	Typ: String Beispiel: "iaa_user1" oder "*", um alle Konten bis zu 100 Konten aufzulisten, es werden Wildcards unterstützt.
domain	Domäne, in der nach Benutzerkonten gesucht werden soll.	Typ: String Beispiel: ospanuser-mail
gesperrt	Status der Benutzerkontosperre	Typ: boolesch Beispiel: "True" oder "False"
offset	Index des ersten zurückgegebenen Benutzerkontos. Der Offset-Parameter ist besonders wichtig, wenn mehr als 100 Benutzer registriert sind; er wird verwendet, um durch die registrierten Konten zu paginieren, beginnend mit dem angegebenen Wert	Typ: Ganzzahl Standardwert: 0 Beispiel: 100 (dies listet die Benutzer ab dem 100. Konto auf, und die Anzahl der aufgelisteten Konten hängt vom Parameter "Limit" ab)
grenze	Anzahl der zurückgegebenen Benutzerkonten. Er spielt zusammen mit dem Parameter "offset" eine wichtige Rolle bei der Anpassung der zurückgegebenen Liste, wenn die Anzahl der Konten 100 übersteigt	Typ: Ganzzahl Standardwert : 20 Maximalwert :100 Beispiel: 20

Unten sehen Sie ein einfaches Beispiel dafür, wie die Anfrage-URL mit einigen hinzugefügten Parametern aussehen wird:

https://ospanuser-mail.sdb.tid.onespan.cloud/v1/users?locked=false&offset=20&limit=20

Im Beispiel wurde der Parameter "Offset" auf 20 gesetzt. Der Parameter "Limit" wurde auf 20 und das boolesche Attribut "Locked" auf "False" gesetzt. Dies würde 20 nicht gesperrte Benutzer zurückgeben, beginnend mit dem 20. in Ihrer Liste.

Ausführen der Anforderung

An diesem Punkt sind wir bereit, den REST-Aufruf an den Endpunkt "Users Query" unter Verwendung der interaktiven IAA-Sandbox-API durchzuführen. Um den Endpunkt aufzurufen, klicken Sie auf die im Screenshot unten gezeigte Schaltfläche "Try it out", die sich rechts neben dem Abschnitt für die GET-HTTP-Methode "/users" befindet. 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.

Antwort-Nutzlast

Nachfolgend sehen Sie ein Beispiel für den zurückgegebenen Antwortkörper eines erfolgreichen "/users"-API-Aufrufs.

 

@mailinator{ "total": 20, "offset": 0, "limit": 20, "count": 19, "users": [ { "created": "2020-05-08T22:04:35Z", "domain": "ospanuser-mail", "enabled": true, "isPasswordSet": true, "lastModified": "2020-05-08T22:22:09Z", "lastPasswordUpdate": "2020-05-08T22:04:35Z", "locked": false, "userID": "iaaUser1", "vdpDeliveryMethod": "Default", "emailAddress": "[email protected]", "mobilePhoneNumber": "+1 (555) 555 5555" }, { "created": "2020-05-27T10:35:52Z", "domain": "ospanuser-mail", "enabled": true, "isPasswordSet": true, "lastModified": "2020-05-27T10:35:53Z", "lastPasswordUpdate": "2020-05-27T10:35:52Z", "locked": false, "userID": "any.anyl", "vdpDeliveryMethod": "Default", "authenticators": [ "VDS0119940", "VDS0119940-2", "VDS0119940-

Die folgende Tabelle enthält detailliertere Informationen zu jeder der Eigenschaften aus der obigen Antwort-Nutzlast.

JSON-Antwort-Objekt	Beschreibung	Daten Typ
zählen*	Anzahl der zurückgegebenen Benutzerkonten.	Typ: Ganzzahl Beispiel: 19
grenze*	Maximale Anzahl der angeforderten Benutzerkonten.	Typ: Ganzzahl Beispiel: 20
offset*	Index des ersten zurückgegebenen Benutzerkontos.	Typ: Ganzzahl Beispiel: 0, um mit dem ersten Index zu beginnen
gesamt*	Gesamtanzahl der Benutzerkonten, die mit den Eingabeparametern der Abfrage übereinstimmen.	Typ: Ganzzahl Beispiel: 3
benutzer*	Eine Liste der zurückgegebenen Benutzerkonten, jedes Objekt in der Liste wird in der folgenden Tabelle beschrieben.	Typ: Ein JSON-Array mit den ausgewählten Benutzerkonten. Beispiel: siehe die Antwort oben

Jeder Eintrag im Array "Benutzer" in der obigen Tabelle enthält mindestens die folgenden Felder.

Feld im Array "Benutzer	Beschreibung	Daten Typ
erstellt*	Erstellungszeitstempel für das Benutzerkonto	Typ: String Beispiel: 2019-02-04T11:42:39Z
domain*	Domäne, in der sich das Benutzerkonto befindet.	Typ: String Beispiel: ospanuser-mail
aktiviert*	Gibt an, ob das Benutzerkonto aktiviert ist oder nicht.	Typ: boolesch Beispiel: "True" oder "False"
isPasswordSet*	Gibt an, ob für das Benutzerkonto ein statisches Kennwort festgelegt ist oder nicht.	Typ: boolesch Beispiel: "True" oder "False"
lastModified*	Zeitstempel der letzten Änderung für das Benutzerkonto.	Typ: String Beispiel: 2019-02-04T11:42:39Z
lastPasswordUpdate*	Statisches Passwort Zeitstempel der letzten Aktualisierung.	Typ: String Beispiel: 2019-02-04T11:42:39Z
gesperrt*	Gibt an, ob das Benutzerkonto in einem gesperrten Zustand angelegt wird oder nicht.	Typ: boolesch Beispiel: "True" oder "False"
mdcProfil*	Message Delivery Component (MDC)-Profil zum Senden von Virtual OTP.	Typ: String Beispiel: EUROPE
userID*	Kennung für den Benutzer.	Typ: String Beispiel: iaa_user1
vdpDeliveryMethod*	Zustellmethode für das Senden von virtuellem OTP.	Typ: String Beispiel: SMS
authentifikatoren	Eine Liste der Authentifikatoren, die den einzelnen Benutzern zugewiesen sind.	Typ: JSON Array Beispiel: ["VDS0119940",...]

In diesem Blog haben wir gezeigt, wie Sie den Endpunkt "Benutzerabfrage" verwenden und seine Parameter ändern können, um die aktuelle Liste der registrierten Benutzer in Ihrem Sandbox-Konto abzurufen. Bleiben Sie dran für weitere Blog-Beiträge über die Verwendung der IAA Sandbox API. Wenn Sie in der Zwischenzeit Fragen haben, können Sie uns gerne in den Foren des OneSpan Community Portals erreichen

Sehen Sie sich weitere Endpunkte der Kategorie "Benutzer" an:

• Benutzerregister Endpunkt
• Benutzer entregistrieren Endpunkt
• Benutzer Update Endpunkt/a>