API on Omniac Business

Authentication

Thu, 05 Jan 2017 00:00:00 +0000

Unsere API unterstützt zwei Arten der Authentifizierung. API-Schlüssel sind einfach und unkompliziert zu verwenden, aber auch weniger sicher, da sie von Man-in-the-Middle-Angriffen betroffen sein können. Der sicherere Ansatz ist die Verwendung von OAuth mit Client Credential Flow. Auf diese Weise können wir Ihnen eine Identität bereitstellen oder auch Ihren Identitätsanbieter verwenden.

API Key

Um einen API-Schlüssel verwenden zu können, müssen wir diese Funktion in Ihrem Tenant aktivieren. Der bereitgestellte Schlüssel muss mit jeder Anfrage unter Verwendung des X-API-KEY-Headers gesendet werden.

Alerts

Thu, 05 Jan 2017 00:00:00 +0000

Alerts sind Warnmeldungen, die von omniac Business generiert werden, wenn Datenleck-Vorfälle für bestimmte Attribute festgestellt werden. Diese Alerts sind für die Aufrechterhaltung der Sicherheit und Privatsphäre der Daten der Benutzer von entscheidender Bedeutung. Jeder Alert enthält Details zum Vorfall, einschließlich des betroffenen Attribut, der Quelle, Zeitpunkt des Vorfalls, einer Klassifizierung zur Kritikalität, einer kurzen Standardbeschreibung des Vorfalls und einer Handlungsempfehlung. Je nachdem, welche Details benötigt werden, kann der Alert-Payload angepasst werden.

Attribute

Thu, 05 Jan 2017 00:00:00 +0000

Attribute werden verwendet, um verschiedene personenbezogene Daten eines Benutzers anzulegen und zu überwachen. Jedes angelegte Attribut wird maskiert, gehasht und verschlüsselt gespeichert, um Datenschutz und Sicherheit zu gewährleisten. Es stehen bis zu 39 verschiedene Attribute zur Verfügung – eine detaillierte Liste finden Sie weiter unten. Die Pflege der Attribute erfolgt über den PUT-Endpunkt /attributes. Dabei werden alle Attribute durch die angegebenen ersetzt. Achten Sie daher darauf, auch die bestehenden Attribute mit anzugeben. Auf bestehende Attribute kann über den GET-Endpunkt /profile zugegriffen werden.

Datenstrukturen

Thu, 05 Jan 2017 00:00:00 +0000

Grundlegende Datenstruktur

Thu, 05 Jan 2017 00:00:00 +0000

Hier finden Sie eine kurze einführende Darstellung der Datenstruktur. Jeder Tenant verfügt über mehrere Profile, innerhalb eines Profils gibt es eine Liste mit Attributen und Alerts.

- * tenant
  |- settings
  |
  |- profiles
     |- profile
     |  |- alerts
     |  |- attributes
     |
     |- profile
     |  |- alerts
     |  |- attributes

Profile

Thu, 05 Jan 2017 00:00:00 +0000

Ein Profil enthält alle Informationen zu einem bestimmten Benutzer innerhalb Ihres Tenants. Dieses Profil kombiniert eine Reihe von Attributen, die für einen Benutzer gespeichert wurden, und die ausgelösten Alerts bei festgestellten Datenleck-Vorfällen.

Das Erstellen eines Profils ist so einfach wie das Senden einer POST-Anfrage an den Profil-Endpunkt (/v1/profiles). Der gleiche Endpunkt akzeptiert auch Anfragen mit einer Profil-ID (/v1/profiles/{profileID}) mit den folgenden Methoden:

GET zum Abrufen eines Profils,
DELETE zum Entfernen eines Profils und
PUT zum Speichern neuer Attribute.

Ausführliche Informationen zu Anfragen und Antworten finden Sie in der OpenAPI-Spezifikation.

Tenants

Thu, 05 Jan 2017 00:00:00 +0000

Tenants sind einzelne Kunden oder Organisationen, die den omniac Business-Dienst nutzen. Jeder Tenant verfügt über eigene Benutzer, Daten und Konfigurationen, was eine maßgeschneiderte Sicherheitsüberwachung und -verwaltung ermöglicht. Der Zugriff auf Daten anderer Tenants ist nicht möglich, sodass die Informationen jedes Tenants privat und sicher bleiben.

Konfiguration

Zunächst wird Ihnen von omniac Business ein Tenant zur Verfügung gestellt. Sie oder ein Vertreter von omniac Business können den Tenant dann nach Ihren Bedürfnissen konfigurieren. Die Konfiguration umfasst:

OpenAPI Generator

Thu, 05 Jan 2017 00:00:00 +0000

OpenAPI Generator

Wir empfehlen, den offiziellen OpenAPI Generator zur Generierung des Client-Codes zu verwenden. Der Generator ist unter OpenAPI Generator zu finden. Er bietet verschiedene Optionen zur Generierung von Client-Bibliotheken in unterschiedlichen Programmiersprachen. Er generiert Code auf Basis der OpenAPI-Spezifikation, wie z.B. Funktionen zum Aufrufen der Endpunkte und Typen für die Request- und Response-Bodies.

Client Generation Schritte

Herunterladen der OpenAPI Spezifikation: Laden Sie die OpenAPI-Spezifikationsdatei für omniac Business herunter. Diese Datei liegt im YAML-Format vor und beschreibt die API-Endpunkte, Anfrageparameter und Antwortstrukturen.
Installieren des OpenAPI Generators: Falls noch nicht geschehen, installieren Sie das OpenAPI Generator CLI-Tool. Installationsanweisungen finden Sie in der OpenAPI Generator-Dokumentation.
Den Client generieren: Verwenden Sie die OpenAPI Generator CLI, um den Client-Code zu generieren. Der Befehl sieht in der Regel wie folgt aus:

openapi-generator-cli generate -i path/to/openapi.yaml -g <language> -o path/to/output/directory

Ersetzen Sie <language> durch die gewünschte Programmiersprache (z. B. python, java, javascript usw.) und geben Sie den Pfad zur OpenAPI-Spezifikationsdatei und das Ausgabeverzeichnis an, in dem der generierte Client-Code gespeichert werden soll.

Push-Benachrichtigungen

Thu, 05 Jan 2017 00:00:00 +0000

Um noch schneller benachrichtigt zu werden, bieten wir eine Push-API für neue Alerts an. Sobald ein Datenleck-Vorfall gefunden wird, veröffentlichen wir die Warnmeldung in Ihrem System. Dies geschieht über einen HTTP-Aufruf. Die Zustellung wird auf unserer Seite als abgeschlossen markiert, sobald Ihre API einen 2xx-HTTP-Statuscode zurückgibt.

Um diese Funktion nutzen zu können, müssen Sie sich mit uns in Verbindung setzen, damit wir die Funktion für Ihren Tenant aktivieren können.

Der Payload sieht wie folgt aus:

Verschlüsselung im Client

Thu, 05 Jan 2017 00:00:00 +0000

Neben der Möglichkeit, die zu überwachenden Daten im Klartext an omniac Business zu senden, bieten wir auch an, die Daten bereits normalisiert, verschlüsselt und gehasht zu empfangen. Letzteres ist auch der von uns empfohlene Weg, da so die persönlichen Attribute Ihrer Nutzer nie im Klartext Ihren Firmenkontext verlassen. Die Verarbeitungsschritte, die dafür notwendig sind, müssen identisch mit denen sein, die wir durchführen, bevor wir die Daten zum Durchsuchen unserer Datenleck-Datenbank verwenden. Im Folgenden wird dieses Vorgehen kurz erläutert.