OneSpan Developer: Benutzer-Update-Patch-Methode

Hakim Aldaoub, 16. Februar 2021

In jeder Einrichtung können Benutzerprofile aus einem oder mehreren Gründen Änderungen erfordern. Dies könnte für die Postanschrift des Benutzers, die Telefonnummer oder einfach die Benutzereinstellungen sein. Die Aktualisierungsfunktion gehört zu den CRUD-Operationen und ist für benutzerzentrierte Anwendungen unerlässlich. OneSpan Intelligent Adaptive Authentication (IAA ) stellt den Aktualisierungsendpunkt des Benutzers bereit, um die Eigenschaften des Benutzerkontos über die interaktive Sandbox-API zu ändern. Heute werden wir erklären, wie man ein oder mehrere Felder in einem Benutzerprofil mit einem einzigen RESTful-Aufruf aktualisiert.

Bevor wir beginnen

Bevor Sie erfahren, wie Sie ein Benutzerprofil aktualisieren 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.

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/{[email protected]}

Sie müssen diese URL während des Tutorials nicht angeben. Wir haben sie hier nur als Beispiel für die URL-Struktur eingefügt. Ihre eigentliche Anfrage-URL wird in der Interaktiven API beim Aufruf des Webdienstes automatisch zugewiesen.

Probieren Sie es aus

Um mit der Ereignisvalidierungs-API zu experimentieren, navigieren Sie in Ihrem OneSpan-Community-Konto zum Dokument IAA Sandbox Interactive API. Erweitern Sie im Open API Swagger-Editor die Ressource "Benutzer". Sie finden dann einen Eintrag für die HTTP-Patch-Methode "Users update", wie in der folgenden Abbildung dargestellt:

URL-Pfad-Parameter:

Für den Zweck des Update-Patch-Aufrufs dieses Benutzers gibt es einen erforderlichen Pfadparameter für die eindeutige Benutzerkennung. Der Pfadparameter wird als [email protected] formatiert, der die auf dem vertrauenswürdigen Gerät aktivierte UserID sowie die Benutzerdomäne nach dem "@"-Zeichen enthält. Ersetzen Sie die Benutzerdomäne durch die unten gezeigte Zeichenfolge "Sandbox User". Sie finden diese Zeichenfolge im Abschnitt "Details" Ihrer Sandbox unter der Registerkarte "Intelligente adaptive Authentifizierung" auf der Homepage Ihrer Sandbox.

Benutzer Update-Anfrage Körper

Der Anfragerumpf sieht wie im folgenden Beispiel aus. Beachten Sie, dass es nur eine der folgenden Zeilen sein kann, um das angegebene Feld für das durch ID im Pfadparameter angegebene Benutzerkonto zu aktualisieren.

{ "emailAddress": "[email protected]", "enabled": true, "mdcProfile": "EUROPE", "mobilePhoneNumber": "+1 (508) 366 3437", "phoneNumber": "+1 (508) 366 3437", "staticPassword": "TestABCD", "vdpDeliveryMethod": "Email" }

Nutzlast anfordern

Hinweis: Es gibt keine Pflichtfelder in der JSON-Nutzlast, da der Zweck des Endpunkts darin besteht, ein oder mehrere Felder nach Bedarf der aufrufenden Anwendung zu aktualisieren.

Im Folgenden finden Sie eine Liste der Felder, die über den Endpunkt aktualisiert werden können:

JSON Erforderliche Datenfelder	Beschreibung	Feld Datentyp
emailAdresse	Die zu aktualisierende E-Mail-Adresse für den Endbenutzer.	Typ: string maxLength: 64 Beispiel: "[email protected]"
aktiviert	In diesem Feld wird festgelegt, ob das Konto des Endbenutzers aktiviert oder deaktiviert wird. Wenn Sie True zuweisen, wird das Konto aktiviert, wenn Sie false zuweisen, wird es deaktiviert.	Typ: boolesch Beispiel: True
mdcProfile	Das spezifische Profil der Message Delivery Component für virtuelle Digipass-Nachrichten für einen bestimmten Benutzer. Dies hat Vorrang vor dem in der Benutzerrichtlinie angegebenen MDC-Profil.	Typ: string maxLength: 100 Beispiel: EUROPE
mobilePhoneNummer	Die Mobiltelefonnummer des Endbenutzers.	Typ: string Muster: ^[\+\-0-9 ]{0,20}$ maxLength: 64 Beispiel: "+1 (508) 366 3437&quot
telefonNummer	Die Rufnummer des Endbenutzers.	Typ: string Muster: ^[\+\-0-9 ]{0,20}$ maxLength: 64 Beispiel: "+1 (508) 366 3437&quot
staticPassword	Das statische Passwort des Benutzers.	Typ: String MinLength: 8 MaxLength: 255 Beispiel: TestABCD
vdpDeliveryMethod	Die Versandmethode für den Versand des virtuellen Digipasses. Dies kann per E-Mail, SMS oder Sprache erfolgen.	Typ: String Beispiel: Email

Aufrufen des Endpunkts

Jetzt sind wir bereit, einen RESTful-Aufruf zur Aktualisierung des Benutzerprofils mit der interaktiven IAA-Sandbox-API durchzuführen. Um den Aufruf durchzuführen, klicken Sie auf die Schaltfläche "Try it out", die im Screenshot unten zu sehen ist und sich rechts neben dem Abschnitt der HTTP-PATCH-Methode 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 mit einem 200-Antwortcode, der eine erfolgreiche Anfrage anzeigt.

{ "created": "2021-02-11T02:02:54Z", "domain": "osiaa4-mailinator", "enabled": true, "isPasswordSet": true, "lastModified": "2021-02-11T03:17:16Z", "lastPasswordUpdate": "2021-02-11T02:02:54Z", "locked": false, "mdcProfile": "EUROPE", "userID": "iaaend1", "vdpDeliveryMethod": "SMS", "authenticators": [ "VDS0058266", "VDS0058266-2", "VDS0058266-1" ], "emailAddress": "[email protected]", "mobilePhoneNumber": "+1 (508) 366 3437", "phoneNumber": "+1 (508) 366 3437" }

Beschreibung der Felder der Antwort-Nutzlast

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

Antwort Objekt	Beschreibung	Daten Typ
erstellt *	Der Erstellungszeitstempel für das Benutzerkonto.	Typ: String Beispiel: "2021-02-11T02:02:54Z&quot
domäne *	Die Domäne, in der sich das zu aktualisierende Benutzerkonto befindet.	Typ: string minLength: 1 maxLength: 255 Beispiel: ospanuser-mail
aktiviert *	Das Feld, das angibt, ob das Benutzerkonto aktiviert ist oder nicht.	Typ: Boolesch Beispiel: true
isPasswordSet *	Das Feld, das angibt, ob für das Benutzerkonto ein statisches Kennwort festgelegt ist oder nicht.	Typ: Boolesch Beispiel: true
lastModified*	Der Zeitstempel für das letzte Mal, dass der Authentifikator geändert wurde.	Typ: String Beispiel: 2019-02-04T11:42:39Z
lastPasswordUpdate*	Der Zeitstempel für das letzte Mal, als das statische Kennwort vom Administrator oder dem Endbenutzer aktualisiert wurde.	Typ: String Beispiel: 2019-02-04T11:42:39Z
Gesperrt*	Das Feld gibt an, ob das Benutzerkonto in einem gesperrten Zustand angelegt wird oder nicht.	Typ: Boolesch Beispiel: true
mdcProfil*	Das Message Delivery Component (MDC)-Profil für den Versand von Virtual OTP.	Typ: String Beispiel: Europa
BenutzerID*	Die Benutzerkennung, der der Authentifikator zugeordnet ist.	Typ: string Beispiel: "iaa_user1"
vdpDeliveryMethod*	Die bevorzugte Übertragungsmethode für das Senden von virtuellen OTPs.	Typ: String Beispiel: "SMS"

HTTP-Antwortstatus-Codes:

Die folgende Tabelle zeigt die erwarteten Antwortcodes, wenn Sie versuchen, ein Benutzerkonto zu löschen:

Antwort Status Code	Bedeutung
200	Das Benutzerkonto wird aktualisiert.
400	Eingangsdatenfehler.
403	Der Befehl ist für das Tenant-Admin-Konto verboten.
404	Das Benutzerkonto wird nicht gefunden.
409	Das Benutzerkonto konnte nicht aktualisiert werden.
500	Interner Fehler, Subdienstausfall, Serverabsturz.

Heute haben wir behandelt, wie man eine oder mehrere Eigenschaften für ein bestehendes Benutzerprofil aktualisiert. Wir haben auch behandelt, wie Sie diese Anforderung mit der OneSpan Interactive API durchführen können. Wenn Sie Fragen haben, wenden Sie sich bitte an die OneSpan Community Portal Foren.

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

OneSpan Blog