List Events

ListEvents pulls Events from the ConductorOne system.

This endpoint should be used to synchronize the system log events to external systems.

POST /api/v1/systemlog/events

ListEvents

Go

package main

import(
	"context"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := conductoronesdkgo.New(
        conductoronesdkgo.WithSecurity(shared.Security{
            BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
            Oauth: "<YOUR_OAUTH_HERE>",
        }),
    )

    res, err := s.SystemLog.ListEvents(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.SystemLogServiceListEventsResponse != nil {
        // handle response
    }
}

import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";

const conductoroneSDKTypescript = new ConductoroneSDKTypescript({
  security: {
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
    oauth: "<YOUR_OAUTH_HERE>",
  },
});

async function run() {
  const result = await conductoroneSDKTypescript.systemLog.listEvents();

  console.log(result);
}

run();

curl --request POST \
  --url https://{tenantDomain}.conductor.one/api/v1/systemlog/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pageSize": 123,
  "pageToken": "<string>",
  "since": "2023-11-07T05:31:56Z",
  "sinceEventUid": "<string>",
  "until": "2023-11-07T05:31:56Z",
  "untilEventUid": "<string>"
}
'

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/systemlog/events"

payload = {
    "pageSize": 123,
    "pageToken": "<string>",
    "since": "2023-11-07T05:31:56Z",
    "sinceEventUid": "<string>",
    "until": "2023-11-07T05:31:56Z",
    "untilEventUid": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    pageSize: 123,
    pageToken: '<string>',
    since: '2023-11-07T05:31:56Z',
    sinceEventUid: '<string>',
    until: '2023-11-07T05:31:56Z',
    untilEventUid: '<string>'
  })
};

fetch('https://{tenantDomain}.conductor.one/api/v1/systemlog/events', 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://{tenantDomain}.conductor.one/api/v1/systemlog/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'pageSize' => 123,
    'pageToken' => '<string>',
    'since' => '2023-11-07T05:31:56Z',
    'sinceEventUid' => '<string>',
    'until' => '2023-11-07T05:31:56Z',
    'untilEventUid' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

HttpResponse<String> response = Unirest.post("https://{tenantDomain}.conductor.one/api/v1/systemlog/events")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"pageSize\": 123,\n  \"pageToken\": \"<string>\",\n  \"since\": \"2023-11-07T05:31:56Z\",\n  \"sinceEventUid\": \"<string>\",\n  \"until\": \"2023-11-07T05:31:56Z\",\n  \"untilEventUid\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}.conductor.one/api/v1/systemlog/events")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"pageSize\": 123,\n  \"pageToken\": \"<string>\",\n  \"since\": \"2023-11-07T05:31:56Z\",\n  \"sinceEventUid\": \"<string>\",\n  \"until\": \"2023-11-07T05:31:56Z\",\n  \"untilEventUid\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "list": [
    {}
  ],
  "nextPageToken": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization · string · header · required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Body

application/json

The SystemLogServiceListEventsRequest message.

pageSize · integer<int32> | null

The pageSize field.

pageToken · string | null

The pageToken field.

since · string<date-time> | null

sinceEventUid · string | null

The sinceEventUid field.

sortDirection · enum<string> | null

The sortDirection field.

Available options: SORT_DIRECTION_UNSPECIFIED, SORT_DIRECTION_ASC, SORT_DIRECTION_DESC

until · string<date-time> | null

untilEventUid · string | null

The untilEventUid field.

Response

200 - application/json

Successful response

The SystemLogServiceListEventsResponse message.

list · object[] | null

List contains an array of JSON OCSF events.

nextPageToken · string | null

The nextPageToken field.