Retrieve an Audit Log

Edit on GitHubEdit MD

Request#

Retrieve an Audit Log by Id

GET/api/system/audit-log/{logId}

OpenAPI Spec

Request Parameters#

logId Long required

The unique Id of the Audit Log to retrieve.

Response#

Response Codes

Code	Description
200	The request was successful. The response will contain a JSON body.
400	The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401	You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
404	The object you requested doesn't exist. The response will be empty.
500	There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.
503	The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

Response Body#

auditLog.data Object

Additional details of an audit log.

auditLog.newValue String

The new value of a changed object.

auditLog.oldValue String

The previous value of a changed object.

auditLog.reason String

The reason why the audit log was created.

auditLog.tenantId UUID Available since 1.65.0

The Id of the Tenant associated with this Audit Log. This field will be null for instance-scoped audit logs. The associated audit-log.create event will be delivered as a tenant-scoped event.

auditLog.id Long

The Audit Log unique Id.

auditLog.insertInstant Long

The instant when the Audit Log was created.

auditLog.insertUser String

The user that created the Audit Log.

auditLog.message String

The message of the Audit Log.

Example JSON Response

{
  "auditLog": {
    "data": {
      "externalId": "_applicationA"
    },
    "newValue:": "{\"name\": \"bar\"}",
    "oldValue": "{\"name\": \"foo\"}",
    "reason": "Because I like to change things.",
    "id": 3,
    "insertInstant": 1471796483322,
    "insertUser": "user@fusionauth.io",
    "message": "Changed Application"
  }
}