알림 API 계약

온라인에서 편집하기

웹훅 알림에 대한 API 계약은 단방향 데이터 플로우입니다.

요청

IBM® Verify에서 구성된 웹훅 URL에 대해 수행되는 요청은 HTTP POST입니다. 헤더는 Content-Type 로 application/json 설정되어 있으며, 요청 본문은 단일 IBM Verify 이벤트입니다.
필드 값 참고
메소드 POST
자원 해당사항 없음
Content-type application/json
채택 설정 해제
HTTP 본문 예제를 참조하십시오. 단일 이벤트를 캡슐화하는 JSON 오브젝트

요청 본문 예제

이벤트의 컨텐츠는 이벤트 유형에 따라 다릅니다. 다음 코드는 인증 이벤트의 예제입니다.

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

이벤트에 대한 추가 예제는 이벤트 API를 참조하십시오.

응답

구성된 웹훅 URL은 HTTP 상태가 2XX인 요청에 응답하여 알림이 성공적으로 수신되었음을 표시합니다. 2XX가 아닌 코드가 리턴되면 응답의 HTTP 본문을 읽지 않고 응답이 포함되지 않습니다.
필드 예상 값 참고
상태 코드 2XX 별도로 구성되지 않은 경우.
본문 공백