Privacy consent events payload

Edit online

You can use the following privacy consent event payloads to trigger asynchronous workflows and synchronizations for event notification webhooks and APIs.

Table 1. Privacy consent attributes
Name Data type Description
data.accesstype_id String The access type ID for the consent.
data.accesstype_name String The access type name for the consent.
data.action String Consent created, modified, or deleted.
data.api_grant_type String The grant type of the token used to perform this action.
data.attribute_id String The attribute ID for the consent.
data.attribute_name String The attribute name for the consent.
data.consent_end_time Number The time when the consent is no longer applicable.
data.consent_id The identifier of the consent record.
data.consent_start_time Number The time from which the consent is applicable.
data.consent_state Number The state of the consent. One of the following values. 1 - Consent allow, 2 - Consent deny, 3 - Opt in, 4 - Opt out, 5 - Transparency.
data.custom_attributes String Extra details that were captured during the consent.
data.devicetype String The browser user agent.
data.externaluser Boolean Specifies whether this user is not a Cloud Directory user.
data.geoip_continent_name String The continent name to which IP address resolve.
data.geoip_country_iso_code String The country's ISO code to which IP address resolve.
data.geoip_country_name String The country's name to which IP address resolve.
data.geoip_ip String IP address of system that caused event to be generated.
data.modified String When a consent is updated, this field provides old and new values of properties that were changed.
data.origin String The IP address of system that caused event to be generated.
data.performedby String The action performed by, it could be "user" if a user token, "api" if a client token, other possible values could be - SingleSignOn, Authentication, or UserRegistration.
data.performedby_clientname String The API client name.
data.performedby_type String API, System, or User.
data.purpose_id String The purpose or EULA ID that was consented for.
data.purpose_name String The purpose or EULA name for the consent.
data.purpose_version Number The purpose or EULA version for the consent.
data.realm String The realm of the user who performed the action.
data.resource String "privacy_consent" - Consent: created, modified, or deleted.
data.result String "success" or "failure".
data.subject String The UID of the user that this consent applies to.
  • If externaluser is true, the user is not a Cloud Directory user, and the value is empty or null.
  • If externaluser is false, the user is a Cloud Directory user and has a value.
data.target String The purpose or EULA name.
data.username String The username of the user that this consent applies to.
geoip.city_name

geoio.continent_name

geoip.country_iso_code

geoip.country_name

geoip.location

geoip.region_name

 String Augmented by Event service by using data.origin.

Example

The following code is a sample payload. Use the Events APIs to get the actual attributes. See https://docs.verify.ibm.com/verify/reference/getallevents and 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
}