Chilkat Online Tools

Foxpro / ForgeRock Identity Cloud Collection / Step 2: Get Audit Logs for a Source

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcPayload
LOCAL lcTimestamp
LOCAL lcV_type
LOCAL lcResultCount
LOCAL lcPagedResultsCookie
LOCAL lcTotalPagedResultsPolicy
LOCAL lcTotalPagedResults
LOCAL lcRemainingPagedResults
LOCAL i
LOCAL lnCount_i

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateString("source","{{auditSource}}")
loQueryParams.UpdateInt("_pageSize",10)
loQueryParams.UpdateString("_prettyPrint","true")

loHttp.SetRequestHeader("x-api-secret","{{logApiSecret}}")
loHttp.SetRequestHeader("x-api-key","{{logApiKey}}")

loResp = loHttp.QuickRequestParams("GET","https://<tenant-name>.forgeblocks.com/monitoring/logs",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loQueryParams
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
    ? "Response Header:"
    ? loResp.Header
    ? "Failed."
    RELEASE loResp
    RELEASE loHttp
    RELEASE loQueryParams
    RELEASE loSbResponseBody
    RELEASE loJResp
    CANCEL
ENDIF

RELEASE loResp

* 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

lcResultCount = loJResp.StringOf("resultCount")
lcPagedResultsCookie = loJResp.StringOf("pagedResultsCookie")
lcTotalPagedResultsPolicy = loJResp.StringOf("totalPagedResultsPolicy")
lcTotalPagedResults = loJResp.StringOf("totalPagedResults")
lcRemainingPagedResults = loJResp.StringOf("remainingPagedResults")
i = 0
lnCount_i = loJResp.SizeOfArray("result")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcPayload = loJResp.StringOf("result[i].payload")
    lcTimestamp = loJResp.StringOf("result[i].timestamp")
    lcV_type = loJResp.StringOf("result[i].type")
    i = i + 1
ENDDO

RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp

Curl Command

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

Postman Collection Item JSON

{
  "name": "Step 2: Get Audit Logs for a Source",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "const JSONResponse = pm.response.json();",
          "",
          "// Tests",
          "",
          "pm.test(\"Status code is 200.\", () => {",
          "  pm.expect(pm.response.code).to.eql(200);",
          "});",
          "",
          "pm.test(\"Response contains resultCount or result\", function () {",
          "    pm.expect(JSONResponse).to.have.any.keys('resultCount', 'result');",
          "});"
        ],
        "type": "text/javascript"
      }
    }
  ],
  "request": {
    "auth": {
      "type": "noauth"
    },
    "method": "GET",
    "header": [
      {
        "key": "x-api-key",
        "value": "{{logApiKey}}",
        "type": "text"
      },
      {
        "key": "x-api-secret",
        "value": "{{logApiSecret}}",
        "type": "text"
      }
    ],
    "url": {
      "raw": "{{platformUrl}}/monitoring/logs?source={{auditSource}}&_pageSize=10&_prettyPrint=true",
      "host": [
        "{{platformUrl}}"
      ],
      "path": [
        "monitoring",
        "logs"
      ],
      "query": [
        {
          "key": "source",
          "value": "{{auditSource}}"
        },
        {
          "key": "beginTime",
          "value": "2020-08-27T15:10:36.177Z",
          "disabled": true
        },
        {
          "key": "endTime",
          "value": "{{$isoTimestamp}}",
          "disabled": true
        },
        {
          "key": "_pageSize",
          "value": "10"
        },
        {
          "key": "_prettyPrint",
          "value": "true"
        }
      ]
    },
    "description": "Get log events"
  },
  "response": [
    {
      "name": "List of log events",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/logs?source=<string>&beginTime=<dateTime>&endTime=<dateTime>&_pageSize=<integer>&_pagedResultsCookie=<string>&_prettyPrint=false&_sortKeys=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "logs"
          ],
          "query": [
            {
              "key": "source",
              "value": "<string>"
            },
            {
              "key": "beginTime",
              "value": "<dateTime>"
            },
            {
              "key": "endTime",
              "value": "<dateTime>"
            },
            {
              "key": "_pageSize",
              "value": "<integer>"
            },
            {
              "key": "_pagedResultsCookie",
              "value": "<string>"
            },
            {
              "key": "_prettyPrint",
              "value": "false"
            },
            {
              "key": "_sortKeys",
              "value": "<string>"
            }
          ]
        }
      },
      "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}"
    }
  ]
}