Chilkat Online Tools

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

Back to Collection Items

<?php

// 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 new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$queryParams = new COM("Chilkat.JsonObject");
$queryParams->UpdateString('source','{{auditSource}}');
$queryParams->UpdateInt('_pageSize',10);
$queryParams->UpdateString('_prettyPrint','true');

$http->SetRequestHeader('x-api-secret','{{logApiSecret}}');
$http->SetRequestHeader('x-api-key','{{logApiKey}}');

// resp is a Chilkat.HttpResponse
$resp = $http->QuickRequestParams('GET','https://<tenant-name>.forgeblocks.com/monitoring/logs',$queryParams);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->Header . "\n";
    print 'Failed.' . "\n";

    exit;
}

// 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

$resultCount = $jResp->stringOf('resultCount');
$pagedResultsCookie = $jResp->stringOf('pagedResultsCookie');
$totalPagedResultsPolicy = $jResp->stringOf('totalPagedResultsPolicy');
$totalPagedResults = $jResp->stringOf('totalPagedResults');
$remainingPagedResults = $jResp->stringOf('remainingPagedResults');
$i = 0;
$count_i = $jResp->SizeOfArray('result');
while ($i < $count_i) {
    $jResp->I = $i;
    $payload = $jResp->stringOf('result[i].payload');
    $timestamp = $jResp->stringOf('result[i].timestamp');
    $v_type = $jResp->stringOf('result[i].type');
    $i = $i + 1;
}


?>

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}"
    }
  ]
}