プライバシー同意イベントのペイロード
以下のプライバシー同意イベントのペイロードを使用すると、イベント通知のWebhookやAPIに対して、非同期ワークフローや同期処理をトリガーすることができます。
| 名前 | データ・タイプ | 説明 |
|---|---|---|
| data.accesstype_id | ストリング | 同意のアクセス種別ID。 |
| data.accesstype_name | ストリング | 同意のアクセス種別名。 |
| data.action | ストリング | 同意が作成、変更、または削除されました。 |
| data.api_grant_type | ストリング | このアクションを実行するために使用されるトークンの種類。 |
| data.attribute_id | ストリング | 同意に関する属性ID。 |
| data.attribute_name | ストリング | 同意に関する属性名。 |
| data.consent_end_time | 数値 | 同意が効力を失う時点。 |
| data.consent_id | 同意記録の識別子。 | |
| data.consent_start_time | 数値 | 同意が効力を生じる時点。 |
| data.consent_state | 数値 | 同意の状況。 以下のいずれかの値。 1 - 同意(許可)、2 - 同意(拒否)、3 - オプトイン、4 - オプトアウト、5 - 透明性。 |
| data.custom_attributes | ストリング | 同意取得の際に記録された追加情報。 |
| data.devicetype | ストリング | ブラウザのユーザーエージェント。 |
| data.externaluser | ブール | このユーザーがCloud Directoryユーザーではないかどうかを指定します。 |
| data.geoip_continent_name | ストリング | そのIPアドレスが解決される大陸名。 |
| data.geoip_country_iso_code | ストリング | そのIPアドレスが解決される国のISOコード。 |
| data.geoip_country_name | ストリング | そのIPアドレスが解決される国の名前。 |
| data.geoip_ip | ストリング | イベントの生成の原因となったシステムの IP アドレス。 |
| data.modified | ストリング | 同意内容が更新された際、このフィールドには変更されたプロパティの旧値と新値が表示されます。 |
| data.origin | ストリング | イベントの発生原因となったシステムのIPアドレス。 |
| data.performedby | ストリング | 実行されるアクションは、ユーザートークンの場合は「user」、クライアントトークンの場合は「api」となります。その他の値としては、 SingleSignOn, 認証や UserRegistration などが考えられます。 |
| data.performedby_clientname | ストリング | APIクライアント名。 |
| data.performedby_type | ストリング | API、システム、またはユーザー。 |
| data.purpose_id | ストリング | 同意された目的またはEULA ID。 |
| data.purpose_name | ストリング | 同意の目的またはEULAの名称。 |
| data.purpose_version | 数値 | 同意の対象となる目的またはEULAのバージョン。 |
| data.realm | ストリング | その操作を実行したユーザーの領域。 |
| data.resource | ストリング | 「privacy_consent」 - 同意:作成、変更、または削除。 |
| data.result | ストリング | 「成功」か「失敗」。 |
| data.subject | ストリング | この同意が適用されるユーザーのUID。
|
| data.target | ストリング | 目的またはEULAの名称。 |
| 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",
"as_org": "SOFTLAYER",
"city_name": null,
"country_iso_code": "USA",
"ip": "169.54.48.202",
"country_name": "United States",
"region_name": null,
"location": {
"lon": "-97.822",
"lat": "37.751"
},
"asn": 36351
},
"data": {
"api_grant_type": "client_credentials",
"consent_state": 1,
"geoip_country_iso_code": "US",
"subject": "61400027ES",
"origin": "169.54.48.202",
"purpose_id": "purposeFor_marketing-t9aid-7dax6o",
"geoip_city_name": "Fort Worth",
"devicetype": "frisby/2.1.3 (+https://github.com/vlucas/frisby)",
"custom_attributes": "[{\"name\":\"ca1\",\"value\":\"cv1\"},{\"name\":\":\\\"{}|;{[]\",\"value\":\"согласие\"},{\"name\":\"ca2\",\"value\":\"\"}]",
"result": "success",
"accesstype_id": "ed434bed-8d07-47f1-8b8e-f8495742bd87",
"performedby": "0de79c97-06c0-40c4-a2c1-7569e76d9c15",
"geoip_country_name": "United States",
"action": "created",
"attribute_name": "testAttrName",
"geoip_ip": "64.64.64.64",
"accesstype_name": "PROFILE-MIX-DSPDUA-Auto-WRITE-1690205394322",
"consent_end_time": 2005565419,
"performedby_type": "api",
"resource": "privacy_consent",
"externaluser": false,
"geoip_continent_name": "North America",
"target": "Auto_Scenario_Test_Purpose-PROFILE-MIX-DSPDUA-1690205396480",
"purpose_version": 1,
"purpose_name": "Auto_Scenario_Test_Purpose-PROFILE-MIX-DSPDUA-1690205396480",
"attribute_id": "testAttrId",
"consent_start_time": 1690205419,
"realm": "cloudIdentityRealm",
"performedby_clientname": "Auto Client",
"consent_id": "8a810177-09cf-452b-935f-a03129df739e",
"username": "jessica"
},
"year": 2023,
"@metadata": {
"source_dc": "WDC01"
},
"event_type": "privacy_consent",
"month": 7,
"indexed_at": 1690205419523,
"@processing_time": 143,
"tenantid": "d75f21d8-fbea-459c-b217-633c1328aa78",
"correlationid": "CORR_ID-AKd7616909-ff69-47af-965b-36de10403edd",
"servicename": "dpcm_rt",
"tenantname": "dpcm-auto-rel.ite2.idng.ibmcloudsecurity.com",
"id": "bcbb72b7-91c2-4119-9443-1a22aecc6cc9",
"time": 1690205419380,
"day": 24
}