通知 API 規約

オンラインで編集

Webhook 通知の API 規約は、片方向のデータ・フローです。

要求

IBM® Verify から構成済み Webhook URL に対して行われる要求は、HTTP POST です。 Content-Type ヘッダーは application/json に設定され、リクエストボディは一つの IBM Verify イベントである。
フィールド 値 注
メソッド POST
リソース N/A
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 を参照してください。

応答

構成された Webhook URL は、要求に HTTP 状況 2XX で応答して通知が正常に受信されたことを示します。 2XX 以外のコードが返された場合、応答の HTTP 本文は読み取られず、応答は含まれません。
フィールド 予期される値 注
状況コード 2XX 特に構成されていない場合。
本文 空