AttackForge Enterprise & AttackForge Core
Powered By GitBook
GetUserAuditLogs
This method can be used for the following functionality: Get audit logs for a user.

Parameters

The following URL, Headers and Parameters are required for requests to this API endpoint. Where a parameter is optional, it will be indicated. Otherwise treat all parameters as mandatory.

Headers

1
GET /api/ss/user/:id/auditlogs HTTP/1.1
2
Host: demo.attackforge.com
3
X-SSAPI-KEY: APIKey
4
Content-Type: application/json
5
Connection: close
Copied!

Query

id (string)
Id of the user.
Example:
1
GET /api/ss/user/5d5b27734a83a708c46f4748/auditlogs HTTP/1.1
Copied!
skip (integer) (optional)
Number of records to skip. Default is 0 (do not skip any records).
Example:
1
GET /api/ss/user/:id/auditlogs?skip=10 HTTP/1.1
Copied!
limit (integer) (optional)
Number of records to limit to. Default limit is 100. Max limit is 500.
Example:
1
GET /api/ss/user/:id/auditlogs?limit=100 HTTP/1.1
Copied!

Example

The following example is a cURL request to get last 500 audit logs for a user.

Request

Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.
1
curl -X GET 'https://demo.attackforge.com/api/ss/user/5d5b27734a83a708c46f4748/auditlogs?skip=0&limit=500' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close'
Copied!

Response

Response contains an array of logs.
1
{
2
"count": 999,
3
"logs":[
4
{
5
"created": "...",
6
"action": "...",
7
"description": "...",
8
"error": "...",
9
"ip": "...",
10
"verbosity": 999,
11
"id": "...",
12
"userId": "...",
13
"projectId": "..."
14
}
15
]
16
}
Copied!
Last modified 1mo ago