User Logs
Used to fetch a log containing all the activities performed by the given user.
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
GET https://{tenantId}.{hostname}/digitanium/v4/user/{userName}/logs?limit=<limit>&offset=<offset>
HTTP request URL for SHIFT
GET https://{hostname}/auth/realms/{tenantId}/v3_user/{userName}/logs?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 to limit the number of rows returned in a query result. (query parameter) |
offset | Integer | Value allows to specify which row to start from retrieving data. (query parameter) |
Request body
No request body fields are required.
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 | Array | List of all User log details for the given userId. |
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 true. |
reportingFilterUsed | List | List of available filters used for a given userId. |
reportingInfoItems | List | List of available info items used for a given userId. |
Sample Response
{
"data": {
"moreResultsAvailable": true,
"reportingFilterUsed": {
"deviceId": "null",
"limit": 10,
"offset": 12,
"userId": "sony"
},
"reportingInfoItems": [{
"action": "35",
"archived": false,
"certificateSerialNumber": "2033460265",
"details": "key=KS.IP; owner=OWNER_DEVICE",
"deviceId": "4184",
"id": 185758,
"issuerDN": "CN=asm internal ca ec58ecd4-0fc3-4fb8-a062-d6ae4aa01e30,UID=DctH2B9f1l,O=KOBIL SYSTEMS,C=DE",
"logDate": "1600963169",
"status": "0",
"userId": "sony"
},
{
"action": "13",
"archived": false,
"certificateSerialNumber": "2033460265",
"deviceId": "4184",
"id": 185757,
"issuerDN": "CN=asm internal ca ec58ecd4-0fc3-4fb8-a062-d6ae4aa01e30,UID=DctH2B9f1l,O=KOBIL SYSTEMS,C=DE",
"logDate": "1600963167",
"status": "0",
"userId": "sony"
},
{
"action": "22",
"archived": false,
"certificateSerialNumber": "2033460265",
"deviceId": "4184",
"id": 183735,
"issuerDN": "CN=asm internal ca ec58ecd4-0fc3-4fb8-a062-d6ae4aa01e30,UID=DctH2B9f1l,O=KOBIL SYSTEMS,C=DE",
"logDate": "1600109713",
"status": "0",
"userId": "sony"
},
{
"action": "35",
"archived": false,
"certificateSerialNumber": "2033460265",
"details": "key=KS.qrcodeNonce; owner=OWNER_DEVICE",
"deviceId": "4184",
"id": 183734,
"issuerDN": "CN=asm internal ca ec58ecd4-0fc3-4fb8-a062-d6ae4aa01e30,UID=DctH2B9f1l,O=KOBIL SYSTEMS,C=DE",
"logDate": "1600109702",
"status": "0",
"userId": "sony"
},
{
"action": "35",
"archived": false,
"certificateSerialNumber": "2033460265",
"details": "key=KS.geoLocation; owner=OWNER_DEVICE",
"deviceId": "4184",
"id": 183733,
"issuerDN": "CN=asm internal ca ec58ecd4-0fc3-4fb8-a062-d6ae4aa01e30,UID=DctH2B9f1l,O=KOBIL SYSTEMS,C=DE",
"logDate": "1600109696",
"status": "0",
"userId": "sony"
},
{
"action": "35",
"archived": false,
"certificateSerialNumber": "2033460265",
"details": "key=KS.IP; owner=OWNER_DEVICE",
"deviceId": "4184",
"id": 183732,
"issuerDN": "CN=asm internal ca ec58ecd4-0fc3-4fb8-a062-d6ae4aa01e30,UID=DctH2B9f1l,O=KOBIL SYSTEMS,C=DE",
"logDate": "1600109693",
"status": "0",
"userId": "sony"
},
{
"action": "13",
"archived": false,
"certificateSerialNumber": "2033460265",
"deviceId": "4184",
"id": 183731,
"issuerDN": "CN=asm internal ca ec58ecd4-0fc3-4fb8-a062-d6ae4aa01e30,UID=DctH2B9f1l,O=KOBIL SYSTEMS,C=DE",
"logDate": "1600109690",
"status": "0",
"userId": "sony"
},
{
"action": "22",
"archived": false,
"certificateSerialNumber": "2033460265",
"deviceId": "4184",
"id": 183730,
"issuerDN": "CN=asm internal ca ec58ecd4-0fc3-4fb8-a062-d6ae4aa01e30,UID=DctH2B9f1l,O=KOBIL SYSTEMS,C=DE",
"logDate": "1600109559",
"status": "0",
"userId": "sony"
},
{
"action": "35",
"archived": false,
"certificateSerialNumber": "2033460265",
"details": "key=KS.qrcodeNonce; owner=OWNER_DEVICE",
"deviceId": "4184",
"id": 183729,
"issuerDN": "CN=asm internal ca ec58ecd4-0fc3-4fb8-a062-d6ae4aa01e30,UID=DctH2B9f1l,O=KOBIL SYSTEMS,C=DE",
"logDate": "1600109551",
"status": "0",
"userId": "sony"
},
{
"action": "35",
"archived": false,
"certificateSerialNumber": "2033460265",
"details": "key=KS.geoLocation; owner=OWNER_DEVICE",
"deviceId": "4184",
"id": 183728,
"issuerDN": "CN=asm internal ca ec58ecd4-0fc3-4fb8-a062-d6ae4aa01e30,UID=DctH2B9f1l,O=KOBIL SYSTEMS,C=DE",
"logDate": "1600109544",
"status": "0",
"userId": "sony"
}
]
},
"message": "Logs fetched successfully",
"status": "OK",
"subSystem": 5
}
Response Status Information
Status Code | Status | Message |
---|---|---|
200 | OK | Logs fetched successfully |
401 | Unauthorized | HTTP 401 Unauthorized |
404 | USER_NOT_FOUND | User does not exist |