Chilkat Online Tools

Powershell / ForgeRock Identity Cloud Collection / Step 1: Get Audit Log Sources

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

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

$http = New-Object Chilkat.Http

$queryParams = New-Object Chilkat.JsonObject
$queryParams.UpdateString("_prettyPrint","true")

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

$resp = $http.QuickRequestParams("GET","https://<tenant-name>.forgeblocks.com/monitoring/logs/sources",$queryParams)
if ($http.LastMethodSuccess -eq $false) {
    $($http.LastErrorText)
    exit
}

$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)

$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($resp.Header)
    $("Failed.")

    exit
}

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

# {
#   "result": [
#     "<string>",
#     "<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 -lt $count_i) {
    $jResp.I = $i
    $strVal = $jResp.StringOf("result[i]")
    $i = $i + 1
}

Curl Command

curl -G -d "_prettyPrint=true"
	-H "x-api-key: {{logApiKey}}"
	-H "x-api-secret: {{logApiSecret}}"
https://<tenant-name>.forgeblocks.com/monitoring/logs/sources

Postman Collection Item JSON

{
  "name": "Step 1: Get Audit Log Sources",
  "event": [
    {
      "listen": "test",
      "script": {
        "exec": [
          "const JSONResponse = JSON.parse(responseBody);",
          "",
          "// Did request contain results?",
          "if(JSONResponse.resultCount && JSONResponse.resultCount > 0)",
          "{",
          "  // Set `managedUserId` variable",
          "  pm.globals.set(\"auditSource\", JSONResponse.result[0]);",
          "}",
          "else",
          "{",
          "  pm.globals.set(\"auditSource\", \"none_found\");  ",
          "}",
          "",
          "",
          "// Tests",
          "",
          "pm.test(\"Status code is 200.\", () => {",
          "  pm.expect(pm.response.code).to.eql(200);",
          "});",
          "",
          "pm.test(\"Response contains tokenId or authId\", 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}}"
      },
      {
        "key": "x-api-secret",
        "value": "{{logApiSecret}}",
        "type": "text"
      }
    ],
    "url": {
      "raw": "{{platformUrl}}/monitoring/logs/sources?_prettyPrint=true",
      "host": [
        "{{platformUrl}}"
      ],
      "path": [
        "monitoring",
        "logs",
        "sources"
      ],
      "query": [
        {
          "key": "_prettyPrint",
          "value": "true"
        }
      ]
    },
    "description": "Get log sources"
  },
  "response": [
    {
      "name": "List of log sources",
      "originalRequest": {
        "method": "GET",
        "header": [
        ],
        "url": {
          "raw": "{{baseUrl}}/logs/sources?_pageSize=<integer>&_pagedResouresOffset=<integer>&_prettyPrint=false",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "logs",
            "sources"
          ],
          "query": [
            {
              "key": "_pageSize",
              "value": "<integer>"
            },
            {
              "key": "_pagedResouresOffset",
              "value": "<integer>"
            },
            {
              "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\"<string>\",\n\t\t\"<string>\"\n\t],\n\t\"resultCount\": \"<integer>\",\n\t\"pagedResultsCookie\": \"<string>\",\n\t\"totalPagedResultsPolicy\": \"<string>\",\n\t\"totalPagedResults\": \"<integer>\",\n\t\"remainingPagedResults\": \"<integer>\"\n}"
    }
  ]
}