Chilkat Online Tools

Powershell / Support API / Show Audit Log

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-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

$http.BasicAuth = $true
$http.Login = "login"
$http.Password = "password"

$http.SetRequestHeader("Accept","application/json")

$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://example.zendesk.com/api/v2/audit_logs/:audit_log_id",$sbResponseBody)
if ($success -eq $false) {
    $($http.LastErrorText)
    exit
}

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

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

$respStatusCode = $http.LastStatus
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($http.LastHeader)
    $("Failed.")
    exit
}

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

# {
#   "audit_log": {
#     "action": "<string>",
#     "action_label": "<string>",
#     "actor_id": "<integer>",
#     "actor_name": "<string>",
#     "change_description": "<string>",
#     "created_at": "<dateTime>",
#     "id": "<integer>",
#     "ip_address": "<string>",
#     "source_id": "<integer>",
#     "source_label": "<string>",
#     "source_type": "<string>",
#     "url": "<string>"
#   }
# }

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

$Action = $jResp.StringOf("audit_log.action")
$Action_label = $jResp.StringOf("audit_log.action_label")
$Actor_id = $jResp.StringOf("audit_log.actor_id")
$Actor_name = $jResp.StringOf("audit_log.actor_name")
$Change_description = $jResp.StringOf("audit_log.change_description")
$Created_at = $jResp.StringOf("audit_log.created_at")
$Id = $jResp.StringOf("audit_log.id")
$Ip_address = $jResp.StringOf("audit_log.ip_address")
$Source_id = $jResp.StringOf("audit_log.source_id")
$Source_label = $jResp.StringOf("audit_log.source_label")
$Source_type = $jResp.StringOf("audit_log.source_type")
$v_Url = $jResp.StringOf("audit_log.url")

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/audit_logs/:audit_log_id

Postman Collection Item JSON

{
  "name": "Show Audit Log",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/audit_logs/:audit_log_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "audit_logs",
        ":audit_log_id"
      ],
      "variable": [
        {
          "key": "audit_log_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### Allowed For\n\n* Admins on accounts that have audit-log access\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/audit_logs/:audit_log_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "audit_logs",
            ":audit_log_id"
          ],
          "variable": [
            {
              "key": "audit_log_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"audit_log\": {\n    \"action\": \"<string>\",\n    \"action_label\": \"<string>\",\n    \"actor_id\": \"<integer>\",\n    \"actor_name\": \"<string>\",\n    \"change_description\": \"<string>\",\n    \"created_at\": \"<dateTime>\",\n    \"id\": \"<integer>\",\n    \"ip_address\": \"<string>\",\n    \"source_id\": \"<integer>\",\n    \"source_label\": \"<string>\",\n    \"source_type\": \"<string>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}