Enterprise

Record an audit event for a change made in the console

Ingest for the few mutations that happen in the customer console's own database, so the control plane never sees them. Everything the control plane changes itself is recorded by its own handler and is not accepted here. The organization, actor, address and time are derived on the server; the body names only the action, an optional target and a small before and after summary. Requires an API key whose role may manage identity settings (admin or owner); a widget JWT is refused with 403, and a 503 means the audit log is not configured on the deployment.

post/audit

Request

  • Base URL: https://api.customdomain.ai/v1
  • URL: https://api.customdomain.ai/v1/audit
  • Auth: HTTP bearer

Request body

action'whitelabel.configured' | 'api_key.default_revealed' required

The console-recordable verb. Any other value is refused with 400.

targetstring

What the event is about. Defaults to the caller's own organization when empty.

beforeobject

A small summary of the state before the change; at most 24 keys.

afterobject

A small summary of the state after the change; at most 24 keys.

Response

Recorded

recordedboolean required
actionstring required

The verb that was recorded.

Changes

No recorded changes to this operation across all 1 revision of this API.