Audit informations

Using this API, audit informations can be retrieved as per the request provided.

Resource Informations

Name	Value
Requires authentication?	Yes
Rate limited?	No

Request

Request headers

Key	Value
Authorization	Bearer token
Content-Type	application/json

HTTP request URL for SSMS

POST https://{tenantId}.{hostname}/digitanium/v4/monitor/audit?limit=<limit>&offset=<offset>

HTTP request URL for SHIFT

POST https://{hostname}/auth/realms/{tenantId}/v3_monitor/{auditItems}?limit=<limit>&offset=<offset>

note

At this moment, this API is applicable only for SSMS based installations.

note

API requests must be made over https. Calls made over plain http will fail.

Parameters

Parameter Name	Type	Description
limit	Integer	provide limit
offset	Integer	provide offset

Request body(*Required)

Field Name	Type	Description

• KernelAuditingFilter | Object | Filters to be applied for retrieving response,The date from must be chronologically before the to date.Either from date or to date must be present in request.

Sample Request

{
  "auditAction": 0,
  "auditSubject": 0,
  "details": null,
  "from": "20042019",
  "moduleId": null,
  "operatorName": null,
  "operatorRoleId": 0,
  "subjectId": null,
  "to": 21042019
}

Response

Field Name	Type	Description
message	String	Message explains result of the API call. Refer Response status Information for details.
status	String	The status of the API call. Refer Response status Information for details.
subSystem	Integer	subSystem categorizes the type of API that has been called. Refer Subsystem details for details.
data	Object	Received auditing information
auditingFilterUsed	Object	Filters applied for retrieving auditing information
auditingInfoItems	Object	Auditing information
moreResultsAvailable	Boolean	There are presently no more response elements accessible if the MoreResultsAvailable response element returns false. True if there are more results available to fetch. Defaults to false.

Sample Response

{
    "data": {
        "auditingFilterUsed": {
            "from": "20042019",
            "limit": 10,
            "moduleId": "kernel",
            "offset": 0,
            "to": "21042019"
        },
        "auditingInfoItems": [],
        "moreResultsAvailable": false
    },
    "message": "Received Response",
    "status": "OK",
    "subSystem": 4
}

Response Status Information

Status Code	Status	Message
200	OK	Received Response.
400	INVALID_ARGUMENT	Either to date or from date must be present both could not be null.
401	Unauthorized	HTTP 401 Unauthorized.
400	Not Found	Unable to extract parameter from http request.