Chilkat Online Tools

autoit / ForgeRock Identity Cloud Collection / Step 4: Tail the Audit Logs for a Source Since Last Request

Back to Collection Items

; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("source","{{auditSource}}")
$oQueryParams.UpdateString("_pagedResultsCookie","{{pagedResultsCookie}}")
$oQueryParams.UpdateString("_prettyPrint","false")

$oHttp.SetRequestHeader "x-api-secret","{{logApiSecret}}"
$oHttp.SetRequestHeader "x-api-key","{{logApiKey}}"

Local $oResp = $oHttp.QuickRequestParams("GET","https://<tenant-name>.forgeblocks.com/monitoring/logs/tail",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)

; {
;   "result": [
;     {
;       "payload": "<object>",
;       "timestamp": "<dateTime>",
;       "type": "<string>"
;     },
;     {
;       "payload": "<object>",
;       "timestamp": "<dateTime>",
;       "type": "<string>"
;     }
;   ],
;   "resultCount": "<integer>",
;   "pagedResultsCookie": "<string>",
;   "totalPagedResultsPolicy": "<string>",
;   "totalPagedResults": "<integer>",
;   "remainingPagedResults": "<integer>"
; }

; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

Local $sPayload
Local $sTimestamp
Local $sV_type

Local $sResultCount = $oJResp.StringOf("resultCount")
Local $sPagedResultsCookie = $oJResp.StringOf("pagedResultsCookie")
Local $sTotalPagedResultsPolicy = $oJResp.StringOf("totalPagedResultsPolicy")
Local $sTotalPagedResults = $oJResp.StringOf("totalPagedResults")
Local $sRemainingPagedResults = $oJResp.StringOf("remainingPagedResults")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("result")
While $i < $iCount_i
    $oJResp.I = $i
    $sPayload = $oJResp.StringOf("result[i].payload")
    $sTimestamp = $oJResp.StringOf("result[i].timestamp")
    $sV_type = $oJResp.StringOf("result[i].type")
    $i = $i + 1
Wend

Curl Command

curl -G -d "source=%7B%7BauditSource%7D%7D"
	-d "_pagedResultsCookie=%7B%7BpagedResultsCookie%7D%7D"
	-d "_prettyPrint=false"
	-H "x-api-key: {{logApiKey}}"
	-H "x-api-secret: {{logApiSecret}}"
https://<tenant-name>.forgeblocks.com/monitoring/logs/tail

Postman Collection Item JSON

{
  "name": "Step 4: Tail the Audit Logs for a Source Since Last Request",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "const jsonData = JSON.parse(responseBody);",
          "if(jsonData.pagedResultsCookie && jsonData.pagedResultsCookie != \"\"){",
          "    pm.globals.set(\"pagedResultsCookie\", jsonData.pagedResultsCookie);",
          "}",
          "",
          "// Tests",
          "",
          "pm.test(\"Status code is 200.\", () => {",
          "  pm.expect(pm.response.code).to.eql(200);",
          "});",
          "",
          "pm.test(\"Response contains results\", function () {",
          "    pm.expect(jsonData).to.have.any.keys('resultCount', 'result');",
          "});",
          "",
          "pm.test(\"Response contains pagedResultsCookie\", function () {",
          "    pm.expect(jsonData).to.have.any.keys('pagedResultsCookie');",
          "});",
          ""
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "auth": {
      "type": "noauth"
    },
    "method": "GET",
    "header": [
      {
        "key": "x-api-key",
        "type": "text",
        "value": "{{logApiKey}}"
      },
      {
        "key": "x-api-secret",
        "type": "text",
        "value": "{{logApiSecret}}"
      }
    ],
    "url": {
      "raw": "{{platformUrl}}/monitoring/logs/tail?source={{auditSource}}&_pagedResultsCookie={{pagedResultsCookie}}&_prettyPrint=false",
      "host": [
        "{{platformUrl}}"
      ],
      "path": [
        "monitoring",
        "logs",
        "tail"
      ],
      "query": [
        {
          "key": "source",
          "value": "{{auditSource}}"
        },
        {
          "key": "_pagedResultsCookie",
          "value": "{{pagedResultsCookie}}"
        },
        {
          "key": "_prettyPrint",
          "value": "false"
        }
      ]
    },
    "description": "Tail log events"
  },
  "response": [
    {
      "name": "List of log events",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/logs/tail?source=<string>&_pagedResultsCookie=<string>&_prettyPrint=false",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "logs",
            "tail"
          ],
          "query": [
            {
              "key": "source",
              "value": "<string>"
            },
            {
              "key": "_pagedResultsCookie",
              "value": "<string>"
            },
            {
              "key": "_prettyPrint",
              "value": "false"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n\t\"result\": [\n\t\t{\n\t\t\t\"payload\": \"<object>\",\n\t\t\t\"timestamp\": \"<dateTime>\",\n\t\t\t\"type\": \"<string>\"\n\t\t},\n\t\t{\n\t\t\t\"payload\": \"<object>\",\n\t\t\t\"timestamp\": \"<dateTime>\",\n\t\t\t\"type\": \"<string>\"\n\t\t}\n\t],\n\t\"resultCount\": \"<integer>\",\n\t\"pagedResultsCookie\": \"<string>\",\n\t\"totalPagedResultsPolicy\": \"<string>\",\n\t\"totalPagedResults\": \"<integer>\",\n\t\"remainingPagedResults\": \"<integer>\"\n}"
    }
  ]
}