Skip to main content
GET
/
api
/
v2
/
workspaces
/
{workspaceId}
/
agent
/
tools
/
users
/
{userId}
/
directory-logs
Agent tool list directory logs
curl --request GET \
  --url https://api.example.com/api/v2/workspaces/{workspaceId}/agent/tools/users/{userId}/directory-logs
import requests

url = "https://api.example.com/api/v2/workspaces/{workspaceId}/agent/tools/users/{userId}/directory-logs"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/api/v2/workspaces/{workspaceId}/agent/tools/users/{userId}/directory-logs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v2/workspaces/{workspaceId}/agent/tools/users/{userId}/directory-logs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v2/workspaces/{workspaceId}/agent/tools/users/{userId}/directory-logs"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/api/v2/workspaces/{workspaceId}/agent/tools/users/{userId}/directory-logs")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v2/workspaces/{workspaceId}/agent/tools/users/{userId}/directory-logs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "data": {
    "success": true,
    "summary": "<string>",
    "row_count": 123,
    "truncated": true,
    "columns": [
      "<string>"
    ],
    "rows": [
      [
        "<string>"
      ]
    ],
    "constants": {},
    "next_page_link": "<string>"
  },
  "meta": {
    "requestId": "<string>",
    "timestamp": "<string>"
  }
}
{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "requestId": "<string>",
  "timestamp": "<string>",
  "target": "<string>",
  "errors": {}
}
{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "requestId": "<string>",
  "timestamp": "<string>",
  "target": "<string>",
  "errors": {}
}
{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "requestId": "<string>",
  "timestamp": "<string>",
  "target": "<string>",
  "errors": {}
}
{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "requestId": "<string>",
  "timestamp": "<string>",
  "target": "<string>",
  "errors": {}
}
{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "code": "<string>",
  "requestId": "<string>",
  "timestamp": "<string>",
  "target": "<string>",
  "errors": {}
}

Path Parameters

​
workspaceId
string<uuid>
required
​
userId
string
required

Query Parameters

​
TimeFilteringType
any
required

Time window for the lookup. Allowed values: ThreeHours, SixHours, TwelveHours, TwentyFourHours, FourtyEightHours, Custom. Prefer the smallest window that resolves your specific uncertainty — directory audit volume can be high. Default: TwentyFourHours.

Available options:
ThreeHours,
SixHours,
TwelveHours,
TwentyFourHours,
FourtyEightHours,
Custom,
null
​
StartDate
string<date-time>

UTC start instant for Custom windows. Required when TimeFilteringType is Custom; ignored otherwise.

​
EndDate
string<date-time>

UTC end instant for Custom windows. Required when TimeFilteringType is Custom; ignored otherwise.

​
NextPageLink
string

Pagination cursor returned by a previous call's response. Pass to fetch the next page of results; omit for the first page.

​
EntityName
string

Display name of the user entity being investigated. Surfaced in the audit trail; not used for matching.

​
ResourceId
string

Audit-trail anchor — the ID of the resource the lookup is attributed to. Typically the incident ID.

​
ResourceName
string

Audit-trail anchor — the display name of the resource the lookup is attributed to. Typically the incident title.

Response

OK

Standard v2 API response envelope for single-item responses.

​
data
object

Token-efficient envelope for agent-tool list responses. Rows are stored as parallel arrays aligned to a single shared List<string> AgentToolTabularResult.Columns header so column names are written exactly once rather than once per row.

​
meta
object