Contrat d'API de notifications

Modifier en ligne

Le contrat d'API pour les notifications webhook est un flux de données unidirectionnel.

Demande

La demande effectuée depuis IBM® Verify vers l'URL du webhook configuré est un POST HTTP. L'en-tête Content-Type est défini sur application/json et le corps de la requête contient un seul IBM Verify événement.
Zone Valeur Remarques
Méthode POST
Ressource N/A
Content-type application/json
Accepter Valeur non définie
Corps HTTP Voir l'exemple. Objet JSON qui encapsule un événement unique.

Exemple de corps de demande

Le contenu de l'événement varie en fonction du type d'événement. Le code suivant est un exemple d'événement d'authentification :

{
          "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
        }

Pour plus d'exemples d'événements, voir l'API d'événements.

Réponse

L'URL du webhook configuré répond à une demande avec un statut HTTP de 2XX pour indiquer que la notification a bien été reçue. Si un code autre que 2XX est renvoyé, le corps HTTP de la réponse n'est pas lu et aucune réponse n'est incluse.
Zone Valeur attendue Remarques
Code de statut 2XX Sauf si configuration différente.
Corps Vide