API-Vertrag für Benachrichtigungen

Der API-Vertrag für Webhook-Benachrichtigungen ist ein unidirektionaler Datenfluss.

Anforderung

Die Anforderung, die von IBM® Verify an die konfigurierte Webhook-URL gesendet wird, ist eine HTTP-POST. Der Content-Type Header ist auf application/json gesetzt, und der Request-Body besteht aus einem einzelnen IBM Verify Ereignis.

Feld	Wert	Anmerkungen
Methode	POST
Ressource	Nicht zutreffend
Inhaltstyp	`application/json`
Akzeptieren		Nicht definiert
HTTP-Hauptteil	Sehen Sie sich das Beispiel an.	Ein JSON-Objekt, das ein einzelnes Ereignis kapselt.

Beispiel für Anforderungshauptteil

Der Inhalt des Ereignisses variiert je nach Ereignistyp. Der folgende Code ist ein Beispiel für ein Authentifizierungsereignis:

{
          "geoip": {
            "continent_name": "North America",
            "city_name": "Austin",
            "country_iso_code": "US",
            "ip": "129.42.38.10",
            "country_name": "United States",
            "region_name": "Texas",
            "location": {
              "lon": "-97.7133",
              "lat": "30.4092"
            }
          },
          "data": {
            "result": "success",
            "subtype": "user_password",
            "subject": "50Q4QK9UTM",
            "origin": "129.42.38.10",
            "cause": "Authentication Successful",
            "action": "login",
            "sourcetype": "clouddirectory",
            "realm": "cloudIdentityRealm",
            "devicetype": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/96.0.4664.45 Safari/537.36",
            "target": "https://example.verify.ibm.com/",
            "username": "scott@ibm.com"
          },
          "year": 2022,
          "event_type": "authentication",
          "month": 1,
          "indexed_at": 1641825768059,
          "tenantid": "7fc5e889-c27b-4ff0-96f2-a495e0598e78",
          "tenantname": "example.verify.ibm.com",
          "correlationid": "CORR_ID-1112f59a-5ac2-439b-9c73-dc140932c7d2",
          "servicename": "authsvc",
          "id": "d5dc6c25-0060-4078-bb80-1c218cb5e05a",
          "time": 1641825767367,
          "day": 10
        }

Weitere Beispiele für Ereignisse finden Sie im Ereignis-API.

Antwort

Die konfigurierte Webhook-URL antwortet auf eine Anforderung mit dem HTTP-Status 2XX, um anzuzeigen, dass die Benachrichtigung erfolgreich empfangen wurde. Wenn ein non-2XX-Code zurückgegeben wird, wird der HTTP-Hauptteil der Antwort nicht gelesen und es wird keine Antwort eingeschlossen.

Feld	Erwarteter Wert	Anmerkungen
Statuscode	2XX	Sofern nicht anders konfiguriert.
Body	Leer