Register events payload

Edit online

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

Table 1. Register attributes
Name	Data type	Description
data.devicetype	String	What type of device the registration came from.
data.flow_document_id	String	The UUID of the registration document where the user registered.
data.flow_id	String	The UUID of the flow that the user registered from.
data.flow_name	String	The human readable name of the flow that the user registered from.
data.flow_url	String	The URL of the flow that the user registered from.
data.origin	String	IP address that the user registered from.
data.realm	String	Identity source of user. Examples Cloud Directory - CloudIdentityRealm, IBMid - www.ibm.com SAML Enterprise - AzureRealm LDAP pass-through - www.cloudsecurity.com OIDC - www.yahoo.com
data.result	String	Result of the user registration attempt.
data.session_id	String	Session ID in the profile service that was used to register the user.
data.step	String	The last step that the user was on during the registration when this event was triggered.
data.subtype	String	Type of event that was triggered.
data.userid	String	The user's ID.
data.username	String	The uusername of the user that is being registered.
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",
      "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
}