Skip to main content

SIEM Event

Note

Please note that SIEM event monitoring is only available within the Production environment.

IMPORTANT

The HaaS platform supports distributing SIEM events via logs to a customer’s central logging system. However, attempting to use these streamed SIEM events as a consent store or as a consent source of truth could complicate ongoing consent management. Biza strongly advises against using the SIEM events as a secondary consent store.

General Guidance​

The following statements apply to all events:

  • All events are prepended with @BIZA.SIEM.EVENT@.
  • All events provide pairwised identifiers only with all direct, potentially PII, identifiers masked.
  • All events include a JSON Object called siemDetails which includes interaction identifiers and pairwise customerId, counterParty and account information.

Validated Event Targets​

While it is likely that the HaaS environment can support many other types of events received, the following are currently validated and in use within Production environments:

Payload Structure​

Authorisation​

Authorisation events contain a specific structure broken down as follows:

  • @class: The source class within the HaaS environment the event was emitted from.
  • interactionId: The Interaction ID related to the event.
  • level: A severity level aligned to syslog severities.
  • time: An RFC3339 compliant timestamp.
  • grantId: Grant Identifier.
  • realm: Realm name.
  • realmUserId: User Identifier which triggered this event.
  • realmPrincipal: The principal being managed at the time of the event.
  • atoUserID (Optional): User Identifier of the ATO, if applicable.
  • atoType (Optional): ATO type, if applicable.
  • expiry: An RFC3339 compliant timestamp indicating the expiration time of the Grant.
  • fullMessage containing the full text, as specified in the Message part of Event Types.

Example Payload​

The following is an example of a JSON payload sent via the SIEM engine:

{
"@class": "io.biza.wikkitgate.auth.events.GrantCreationEvent",
"interactionId": "I1",
"level": "INFO",
"time": "2021-06-28T16:00:04Z",
"grantId": "dd8023ac-9f3a-4b63-8f01-64bee901b116",
"realm": "azib-bank",
"realmUserID": "joe-blogs",
"realmPrincipal": "564e6525f6f8408fa641f3f18976fd2c",
"atoUserID": "harry-smith",
"atoType": "POWER_OF_ATTORNEY",
"expiry": "2021-06-29T16:00:04Z",
"fullMessage": "Initial Consent Established with expiry set to 2021-06-29T16:00:04Z by ATO authority of type POWER_OF_ATTORNEY by user harry-smith"
}

Data API​

Data API events contain a specific structure broken down as follows:

  • @class: The source class within the HaaS environment the event was emitted from.
  • interactionId: The Interaction ID related to the event.
  • level: A severity level aligned to syslog severities.
  • time: An RFC3339 compliant timestamp.
  • siemDetails containing the following components:
    • customer object incorporating the PPID for the customer and the counter-party (ie. the ADR sector identifier URI).
    • account object incorporating the PPID of both the customer and the account and the counter-party.
    • interactionId containing the interaction id (x-fapi-interaction-id) associated with CDR Data API calls.
  • upstreamFiltered specifying whether the call was made to a Data Adapter supporting filtering.
  • fullMessage containing the full text, as specified in the Message part of Event Types.

Example Payload​

The following is an example of a JSON payload sent via the SIEM engine:

{
"@class": "io.biza.adapter.events.ListTransactionsUpstreamEvent",
"interactionId": "393c2857-6753-4449-8d48-f59dd394be49",
"level": "INFO",
"time": "2021-08-19T07:32:27.001296Z",
"siemDetails": {
"customer": {
"ppid": "6df5f01d-6d44-4f8f-98f6-00bf1167ce6b",
"ppidCustomerId": "",
"counterParty": "secure.adr.com.au"
},
"account": {
"ppid": "fec107e0-c3c5-4122-831a-e0de52236cb0",
"ppidCustomerId": "6df5f01d-6d44-4f8f-98f6-00bf1167ce6b",
"counterParty": "secure.adr.com.au"
},
"interactionId": "9a65022d-f606-47fe-94c6-e4deac973f8f"
},
"upstreamFiltered": true,
"fullMessage": "List scheduled payments for customer accounts."
}