Audit Record

The Audit record object signifies a specific entity within the platform for which an Audit object is generated. Each Audit object can only be created for one platform object at a time.

Field	Type	Description
id	string, core	(Read-only) The identifier of the object.
name	string, core	(Read-only) The name of the object. If the name doesn't exist, an ID is included.
icon	string, core	(Read-only) The URL of the object icon.
objectType	string, core	(Read-only) The type of object.
revision	integer, core	(Read-only) The revision number of the object.

Example

AUDIT RECORD OBJECT

{
  "id": "ORD-3568-4038-2535",
  "type": "order",
  "icon": null,
  "objectType": "Order",
  "revision": 24
}

Audit Record Actor object

The Audit record object signifies a specific entity within the platform for which an Audit object is generated. Each Audit object can only be created for one platform object at a time.

Field	Type	Description
id	string, core	(Read-only) The ID of the user.
name	string, core	(Read-only) The name of the user.
icon	string, core	(Read-only) The URL to the user's logo.
account	object, core	(Read-only) Represents the auditRecordActorAccount object containing the user's account details. Example: { "id": "ACC-3408-7241", "name": "MPT Commerce e2e client", "icon": "/v1/accounts/accounts/ACC-3408-7241/icon", "accountType": "Client" }

Example

AUDIT RECORD ACTOR OBJECT

 "name": "John Doe",
  "icon": "/v1/accounts/users/USR-0556-8733/icon",
  "account": {
    "id": "ACC-3408-7241",
    "name": "MPT_Commerce e2e client",
    "icon": "/v1/accounts/accounts/ACC-3408-7241/icon",
    "accountType": "Client"
  }
} 

Audit Record Actor Account object

The Identity object represents a user account associated with the creation of an audit object.

Field	Type	Description
id	string, core	(Read-only) (Optional) The account ID.
name	string, core	(Read-only) The account name.
icon	string, core	(Read-only) The URL of the account logo.
accountType	object, core	(Read-only) Represents the account type.

Example

AUDIT RECORD ACTOR ACCOUNT OBJECT

{
  "id": "ACC-3408-7241",
  "name": "MPT Commerce e2e client",
  "icon": "/v1/accounts/accounts/ACC-3408-7241/icon",
  "accountType": "Client"
}

Audit Record Request object

The Request object captures request data that is useful to store as part of the Audit entry.

Field	Type	Description
api	object	(Read-only) (Optional) Represents the apiRequest object. Example: { "ip": "108.141.111.208", "geolocation": { "countryCode": "NL", "countryName": "Netherlands", "region": "North Holland" }, "userAgent": "swo-extensions/1.0" }
worker	object	(Read-only) (Optional) Represents the workerRequest object containing worker request details. Example: { "workerName": "platformWorker" }
log	object	(Read-only) (Optional) Represents the logInfo object containing the logging information or metadata. Example: { "correlationId": "1233213215468" }

API Request object

This object captures metadata related to web-based requests, which is useful to include in the audit entry. It is populated only when the request is a web request.

Field	Type	Description
ip	string	(Read-only) (Optional) A unique identifier of the IP address.
userAgent	string	(Read-only) (Optional) The user agent making the API request.
geolocation	object	(Read-only) The geolocation metadata for the request. Example: { "countryCode": "NL", "countryName": "Netherlands", "region": "North Holland" }

Worker Request object

This object captures metadata for the request worker, which is useful to store as part of the Audit entry. It's populated only when the request is a worker request.

Field	Type	Description
workerName	string	(Read-only) (Optional) The name of the request worker.

Log Info object

This object captures request log metadata to be included in the audit entry.

Field	Type	Description
corellationId	string	(Read-only) (Optional) The ID that can be used to track requests in the logging system.

Audit Record Documents object

The Documents object is a flexible JSON structure designed to hold essential information that characterizes an event. It can represent either a complete or partial depiction of the object related to the audit event, or it may consist of any arbitrary JSON data.

AUDIT RECORD DOCUMENTS OBJECT

{
  "order": {
      "id": "ORD-1208-2301-8479",
      "href": "/commerce/orders/ORD-1208-2301-8479",
      "type": "Termination",
      "status": "Processing"
  },
  "actor": {
      "id": "TKN-8033-2484",
      "name": "Adobe Extension API",
      "icon": "",
      "account": {
          "id": "ACC-1675-9721",
          "name": "Adobe",
          "icon": "/v1/accounts/accounts/ACC-1675-9721/icon",
          "accountType": "Vendor"
      }
  }
}

Audit Record Viewer object

The audit record viewer object signifies a platform account that grants access to specific audit records for its members.

Field	Type	Description
id	string, core	(Read-only) The ID of the account.
name	string, core	(Read-only) The account name.
icon	string, core	(Read-only) The URL to the account logo.
accountType	object, core	(Read-only) The type of account.

Example

AUDIT RECORD VIEWER OBJECT

{
  "id": "ACC-3408-7241",
  "name": "e2e client",
  "type": "Client",
  "icon": "/v1/accounts/accounts/ACC-3408-7241/icon"
}