Retrieve an Audit Log API
On this page
Request#
OpenAPI Spec
Path Parameters#
logIdThe 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 Additional details of an audit log.
auditLog.newValue The new value of a changed object.
auditLog.oldValue The previous value of a changed object.
auditLog.reason The reason why the audit log was created.
auditLog.tenantId 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 The Audit Log unique Id.
auditLog.insertInstant The instant when the Audit Log was created.
auditLog.insertUser The user that created the Audit Log.
auditLog.message The message of the Audit Log.
{
"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"
}
}Related
Learn about the APIs for adding entries to, searching, and exporting the audit log.
API documentation for the FusionAuth Add an Entry to the Audit Log API.
API documentation for the FusionAuth Export Audit Logs API.
API documentation for the FusionAuth Search the Audit Log API.