Skip to content
Toriidocs

Search or poll audit events

POST
/api/server/v1/audit-events/search
curl --request POST \
  --url https://api.toriiauth.eu/api/server/v1/audit-events/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "page": { "mode": "poll", "checkpoint": "example" }, "filters": { "actions": [ "example" ], "actorTypes": [ "user" ], "actorIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "targetTypes": [ "example" ], "targetIds": [ "example" ], "results": [ "success" ], "correlationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" } }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
integer format: int32
>= 1 <= 100

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
page
required
One of: discriminator: mode
object
mode
required
string
Allowed values: poll
checkpoint
string | null
filters
object
actions
Array<string>
<= 100 items unique items
actorTypes
Array<string>
<= 100 items unique items
Allowed values: user platform_user server system
actorIds
Array<string>
<= 100 items unique items
targetTypes
Array<string>
<= 100 items unique items
targetIds
Array<string>
<= 100 items unique items
results
Array<string>
<= 100 items unique items
Allowed values: success failure denied
correlationId
string | null format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

A page of environment audit events.

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string format: uuid
environmentId
required
string format: uuid
sequence
required
integer | null format: int64
action
required
string
result
required
string
Allowed values: success failure denied
occurredAt
required
string format: date-time
recordedAt
required
string format: date-time
actor
required
object
type
required
string
Allowed values: user platform_user server system
id
required
string | null format: uuid
impersonatorId
required
string | null format: uuid
targets
required
Array<object>
object
type
required
string
id
string | null
context
required
object
ipAddress
string | null
<= 45 characters
userAgent
string | null
<= 512 characters
producer
required
One of:
object
secretKeyId
required
string format: uuid
ipAddress
required
string | null
userAgent
required
string | null
metadata
required
object
key
additional properties
any
schemaVersion
required
integer format: int32
correlationId
required
string | null format: uuid
page
required
One of: discriminator: mode
object
mode
required
string
Allowed values: poll
checkpoint
required
string
hasMore
required
boolean
Example
{
  "items": [
    {
      "result": "success",
      "actor": {
        "type": "user"
      }
    }
  ],
  "page": {
    "mode": "poll"
  }
}

400

Section titled “400”

Invalid filters, range, cursor, checkpoint, or limit.

Media typeapplication/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  }
}

401

Section titled “401”

Missing or invalid secret key.

Media typeapplication/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  }
}