List organisation audit log entries
curl --request GET \
--url https://api.uk.veridox.ai/organisations/audit-log \
--header 'x-api-key: <api-key>'import requests
url = "https://api.uk.veridox.ai/organisations/audit-log"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.uk.veridox.ai/organisations/audit-log', 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.uk.veridox.ai/organisations/audit-log",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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.uk.veridox.ai/organisations/audit-log"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
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.uk.veridox.ai/organisations/audit-log")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uk.veridox.ai/organisations/audit-log")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"entries": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"action": "member.role_changed",
"target_type": "member",
"target_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"actor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"actor_role": "<string>",
"actor_type": "user",
"actor_email": "<string>",
"actor_name": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z"
}
],
"total": 4503599627370495,
"limit": 123,
"offset": 4503599627370495
}{
"error_code": "request.cases.file.missing-risk-score",
"error_message": "User tried to perform an invalid operation on a file without a risk score.",
"error_details": {
"field": "email_address"
}
}{
"error_code": "request.cases.file.missing-risk-score",
"error_message": "User tried to perform an invalid operation on a file without a risk score.",
"error_details": {
"field": "email_address"
}
}{
"error_code": "request.cases.file.missing-risk-score",
"error_message": "User tried to perform an invalid operation on a file without a risk score.",
"error_details": {
"field": "email_address"
}
}{
"error_code": "request.cases.file.missing-risk-score",
"error_message": "User tried to perform an invalid operation on a file without a risk score.",
"error_details": {
"field": "email_address"
}
}Organisation
Get Audit Log
List the audit log entries recorded for your organisation.
GET
/
organisations
/
audit-log
List organisation audit log entries
curl --request GET \
--url https://api.uk.veridox.ai/organisations/audit-log \
--header 'x-api-key: <api-key>'import requests
url = "https://api.uk.veridox.ai/organisations/audit-log"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.uk.veridox.ai/organisations/audit-log', 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.uk.veridox.ai/organisations/audit-log",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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.uk.veridox.ai/organisations/audit-log"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
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.uk.veridox.ai/organisations/audit-log")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uk.veridox.ai/organisations/audit-log")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"entries": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"action": "member.role_changed",
"target_type": "member",
"target_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"actor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"actor_role": "<string>",
"actor_type": "user",
"actor_email": "<string>",
"actor_name": "<string>",
"metadata": {},
"created_at": "2023-11-07T05:31:56Z"
}
],
"total": 4503599627370495,
"limit": 123,
"offset": 4503599627370495
}{
"error_code": "request.cases.file.missing-risk-score",
"error_message": "User tried to perform an invalid operation on a file without a risk score.",
"error_details": {
"field": "email_address"
}
}{
"error_code": "request.cases.file.missing-risk-score",
"error_message": "User tried to perform an invalid operation on a file without a risk score.",
"error_details": {
"field": "email_address"
}
}{
"error_code": "request.cases.file.missing-risk-score",
"error_message": "User tried to perform an invalid operation on a file without a risk score.",
"error_details": {
"field": "email_address"
}
}{
"error_code": "request.cases.file.missing-risk-score",
"error_message": "User tried to perform an invalid operation on a file without a risk score.",
"error_details": {
"field": "email_address"
}
}Returns your organisation’s audit log, newest first, with pagination. Filter by
For an action taken with an API key,
action, target_type, actor_id, and a from/to date range.
Permission
Requiresorganisation_settings:read, which the Owner and Admin roles hold by default. A caller without it receives 403.
What Is Recorded
Only the following actions are recorded. Reading data, uploading files and creating cases are not.action | Recorded when |
|---|---|
member.role_changed | A member’s role changes |
role_config.updated | The permissions a role holds change |
file.risk_score_overridden | A file’s risk score is changed |
file.archived | A file is archived |
file.deleted | A file is permanently deleted |
file.reassigned | A file is moved to another case |
case.label_updated | A case label changes |
team.created, team.deleted | A team is created or deleted |
team.member_added, team.member_removed | A member joins or leaves a team |
api_key.created, api_key.revoked | An API key is created or revoked |
verification_settings.updated | The verification setting changes |
knowledge_access.granted, knowledge_access.revoked | Knowledge access is granted or revoked |
knowledge_graph_mode.updated | The knowledge graph mode changes |
Who Made the Change
actor_type says who made each change:
actor_type | Meaning | actor_name |
|---|---|---|
user | A person in your organisation | The person’s name, or [deleted user] if their account no longer exists |
api_key | An API key | The key’s name, which stays after the key is revoked. API key if the name cannot be told apart from another key’s, and [deleted API key] only if no matching key exists |
system | Veridox, acting on your organisation’s behalf | [Veridox admin tool] |
actor_id is the ID of the person who created the key, and actor_email is API key.
Related
- Permissions and API Keys describes which actions an API key can take.
Authorizations
Query Parameters
Required range:
1 <= x <= 100Required range:
0 <= x <= 9007199254740991Available options:
member.role_changed, role_config.updated, file.risk_score_overridden, file.archived, file.deleted, file.reassigned, case.label_updated, team.created, team.deleted, team.member_added, team.member_removed, api_key.created, api_key.revoked, verification_settings.updated, knowledge_access.granted, knowledge_access.revoked, knowledge_graph_mode.updated Available options:
member, organisation, file, case, team, api_key Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Was this page helpful?
⌘I