Skip to content
Toriidocs

Append a customer audit event

POST
/api/server/v1/audit-events
curl --request POST \
  --url https://api.toriiauth.eu/api/server/v1/audit-events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --data '{ "action": "example", "result": "success", "schemaVersion": 1, "occurredAt": "2026-04-15T12:00:00Z", "actor": { "type": "server" }, "targets": [ { "type": "example", "id": "example" } ], "context": { "ipAddress": "example", "userAgent": "example" }, "correlationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "metadata": {} }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
action
required
string
<= 191 characters /^customer\.[a-z0-9]+(?:[._-][a-z0-9]+)*\.[a-z0-9]+(?:[._-][a-z0-9]+)*$/
result
required
string
Allowed values: success failure denied
schemaVersion
required
integer format: int32
>= 1 <= 1
occurredAt
required
string format: date-time
actor
required
One of: discriminator: type
object
type
required
string
Allowed values: server
targets
required
Array<object>
<= 20 items
object
type
required
string
<= 191 characters /^(customer\.[a-z0-9]+(?:[._-][a-z0-9]+)*\.[a-z0-9]+(?:[._-][a-z0-9]+)*|user|session|identity|invitation|environment|secret_key)$/
id
required
string
>= 1 characters <= 512 characters
context
One of:
object
ipAddress
string | null
<= 45 characters
userAgent
string | null
<= 512 characters
correlationId
string | null format: uuid
metadata
required
object

Responses

Section titled “Responses”

201

Section titled “201”

The stored event, or the original event for an idempotent replay.

Media typeapplication/json
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
Example
{
  "result": "success",
  "actor": {
    "type": "user"
  }
}

400

Section titled “400”

Invalid schema, bounds, timestamp, IP address, or idempotency 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"
  }
}

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"
  }
}

402

Section titled “402”

Audit storage is unavailable for this environment.

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"
  }
}

404

Section titled “404”

A referenced resource was not found in this environment.

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"
  }
}

409

Section titled “409”

The idempotency key was reused with different content.

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"
  }
}

429

Section titled “429”

The 600-attempt per-minute threshold was reached for the environment or secret key. Retry-After is returned.

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"
  }
}