Contrato de API de notificações

O contrato de API para notificações de webhook é um fluxo de dados unidirecional.

Solicitação

A solicitação que é feita de IBM® Verify para a URL do webhook configurado é um POST HTTP. O Content-Type cabeçalho está definido como application/json e o corpo da solicitação é um único IBM Verify evento.

Campo	Valor	Notas
Method	POST
Recurso	N/D
Tipo de Conteúdo	`application/json`
Aceitar		Desconfigurar
Corpo HTTP	Consulte o exemplo.	Um objeto JSON que encapsula um único evento.

Exemplo de corpo de solicitação

O conteúdo do evento varia dependendo do tipo de evento. O código a seguir é um exemplo de um evento de autenticação:

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

Para obter mais exemplos de eventos, consulte o API de eventos.

Resposta

A URL do webhook configurado responde a uma solicitação com status de HTTP de 2XX para indicar que a notificação foi recebida com êxito. Se um código diferente de 2XX for retornado, o corpo de HTTP da resposta não será lido e nenhuma resposta será incluída.

Campo	Valor esperado	Notas
Código de status	2XX	A menos que configurado de outra forma.
Conteúdo	Vazio