Share feedback
Answers are generated based on the documentation.

Schema

AuditEvent

Type: object

action_type

Type: string

Action-specific payload discriminator.
All schema constraints and annotations
{
  "description": "Action-specific payload discriminator.",
  "example": "network_egress",
  "type": "string"
}
audit_event_id · required

Type: string

Unique audit event ID.
All schema constraints and annotations
{
  "description": "Unique audit event ID.",
  "format": "uuid",
  "type": "string"
}
audit_session_id

Type: string

Session that produced the event.
All schema constraints and annotations
{
  "description": "Session that produced the event.",
  "type": "string"
}
category

Type: string

Audit event category.
All schema constraints and annotations
{
  "description": "Audit event category.",
  "example": "AUDIT_CATEGORY_EVALUATION",
  "type": "string"
}
created_at

Type: string

Time Docker recorded the event.
All schema constraints and annotations
{
  "description": "Time Docker recorded the event.",
  "format": "date-time",
  "type": "string"
}
decision

Type: string

Governance decision for evaluation records.
All schema constraints and annotations
{
  "description": "Governance decision for evaluation records.",
  "example": "AUDIT_DECISION_DENY",
  "type": "string"
}
enforcement_mode

Type: string

Enforcement mode in effect for the decision.
All schema constraints and annotations
{
  "description": "Enforcement mode in effect for the decision.",
  "example": "enforce",
  "type": "string"
}
event_type · required

Type: string

Fully qualified event schema name.
All schema constraints and annotations
{
  "description": "Fully qualified event schema name.",
  "type": "string"
}
ingested_at

Type: string

Time Docker ingested the event into cloud storage.
All schema constraints and annotations
{
  "description": "Time Docker ingested the event into cloud storage.",
  "format": "date-time",
  "type": "string"
}
org_id · required

Type: string

ID of the organization that owns the event.
All schema constraints and annotations
{
  "description": "ID of the organization that owns the event.",
  "format": "uuid",
  "type": "string"
}
payload

Type: object

Event-specific audit record fields.
All schema constraints and annotations
{
  "additionalProperties": true,
  "description": "Event-specific audit record fields.",
  "type": "object"
}
username

Type: string

Docker username associated with the event.
All schema constraints and annotations
{
  "description": "Docker username associated with the event.",
  "type": "string"
}
All schema constraints and annotations
{
  "properties": {
    "action_type": {
      "description": "Action-specific payload discriminator.",
      "example": "network_egress",
      "type": "string"
    },
    "audit_event_id": {
      "description": "Unique audit event ID.",
      "format": "uuid",
      "type": "string"
    },
    "audit_session_id": {
      "description": "Session that produced the event.",
      "type": "string"
    },
    "category": {
      "description": "Audit event category.",
      "example": "AUDIT_CATEGORY_EVALUATION",
      "type": "string"
    },
    "created_at": {
      "description": "Time Docker recorded the event.",
      "format": "date-time",
      "type": "string"
    },
    "decision": {
      "description": "Governance decision for evaluation records.",
      "example": "AUDIT_DECISION_DENY",
      "type": "string"
    },
    "enforcement_mode": {
      "description": "Enforcement mode in effect for the decision.",
      "example": "enforce",
      "type": "string"
    },
    "event_type": {
      "description": "Fully qualified event schema name.",
      "type": "string"
    },
    "ingested_at": {
      "description": "Time Docker ingested the event into cloud storage.",
      "format": "date-time",
      "type": "string"
    },
    "org_id": {
      "description": "ID of the organization that owns the event.",
      "format": "uuid",
      "type": "string"
    },
    "payload": {
      "additionalProperties": true,
      "description": "Event-specific audit record fields.",
      "type": "object"
    },
    "username": {
      "description": "Docker username associated with the event.",
      "type": "string"
    }
  },
  "required": [
    "audit_event_id",
    "org_id",
    "event_type"
  ],
  "type": "object"
}