Audit Log API (2022-11-16T09:42:10Z)

Download OpenAPI specification:Download

API for the audit log service

Create a new audit log

header Parameters

Content-Type	string
X-Amz-Target	string

Request Body schema: application/json

owner required	string The username, uuid, API token name of the account taking the action.
metadata	object The metadata that is associated with the event.
event_id	string Correlation Id for the event that can be used to filter down to similar events.
system required	string The fully qualified service name(com.newstore..).
occurred_on required	string The server time when the event happened.
action_type	string The corresponding 'C' 'R' 'U' 'D' category.
payload required	object The new state of the target.
domain required	string The domain or bounded context that the actor is a member of(mobile-platform, order-management, web-platform).
action required	string The way in which the object was changed (the verb). E.g. config.tenant.update / template.update
event_name required	string Common name or description of the event. E.g. Associate App tenant configuration has been updated / template was updated
tenant required	string The tenant name.
target required	string The object or underlying resource that is being changed.

Responses

Request samples

Payload

Content type

application/json

{"owner": "string",
"metadata": { },
"event_id": "string",
"system": "string",
"occurred_on": "string",
"action_type": "string",
"payload": { },
"domain": "string",
"action": "string",
"event_name": "string",
"tenant": "string",
"target": "string"
}

Response samples

Content type

application/json

{ }