イベントのペイロードを登録する

オンラインで編集

以下のイベントペイロードを使用して、イベント通知のWebhookやAPIに対して、非同期ワークフローや同期処理をトリガーすることができます。

表 1. 属性の登録
名前 データ・タイプ 説明
data.devicetype ストリング 登録が行われたデバイスの種類。
data.flow_document_id ストリング ユーザーが登録を行った登録文書のUUID。
data.flow_id ストリング ユーザーが登録したフローのUUID。
data.flow_name ストリング ユーザーが登録したフローの、人間が読みやすい名称。
data.flow_url ストリング ユーザーが登録したフローの URL。
data.origin ストリング ユーザーが登録したIPアドレス。
data.realm ストリング

ユーザーの ID ソース。 例

クラウドディレクトリ - CloudIdentityRealm,

IBMid - www.ibm.com

SAML エンタープライズ - AzureRealm

LDAP パススルー - www.cloudsecurity.com

OIDC - www.yahoo.com
data.result ストリング ユーザー登録の試行結果。
data.session_id ストリング ユーザー登録に使用されたプロファイルサービス内のセッションID。
data.step ストリング このイベントが発生した時点で、ユーザーが登録プロセスにおいて最後にいたステップ。
data.subtype ストリング トリガーされたイベントの種類。
data.userid ストリング ユーザーの ID。
data.username ストリング 登録中のユーザーのユーザー名。
geoip.city_name

geoio.continent_name

geoip.country_iso_code

geoip.country_name

geoip.location

geoip.region_name

 ストリング data.origin を使用してイベント・サービスによって拡張

例

以下のコードはペイロードのサンプルです。 実際の属性を取得するには、Events API を使用してください。 https://docs.verify.ibm.com/verify/reference/getallevents および https://docs.verify.ibm.com/verify/docs/pulling-event-data を参照してください。

{
  
    "geoip": {
      "continent_name": "North America",
      "city_name": null,
      "country_iso_code": "USA",
      "ip": "111.11.11.111",
      "country_name": "United States",
      "region_name": null,
      "location": {
        "lon": "-97.822",
        "lat": "37.751"
      }
    },
    "data": {
      "result": "success",
      "flow_url": "22222222222222222222222222",
      "subtype": "completed",
      "flow_id": "33333333-3333-3333-3333-333333333333",
      "origin": "111.11.11.111",
      "session_id": "44444444-4444-4444-4444-444444444444",
      "flow_name": "My test flow name",
      "realm": "cloudIdentityRealm",
      "userid": "5555555555",
      "devicetype": "python-requests/2.22.0",
      "flow_document_id": "aa9a9a9a-9a9a-999-99a9-9aaaaa999999",
      "username": "username.cloudidentity.ibm.com"
    },
    "year": 2023,
    "event_type": "register",
    "month": 2,
    "indexed_at": 1675452230355,
    "tenantid": "66666666-6666-6666-6666-666666666666",
    "tenantname": "tenant name.verify.ibmcloudsecurity.com",
    "correlationid": "CORR_ID-77777777-7777-7777-7777-777777777777",
    "servicename": "profile",
    "id": "88888888-8888-8888-8888-888888888888",
    "time": 1675452229804,
    "day": 3
}