Skip to content

API · audit ​

Trang sinh tự động

Parse từ schema.graphql (SDL backend export) bằng parser graphql. Mô tả và quyền lấy nguyên văn từ description trong SDL.

4 query · 0 mutation.

Query ​

auditActionOptions ​

The actions of the audit registry and of the stored log, for the action filter. Requires audit.read.

query · quyền: audit.read

Không có tham số.

Trả về [AuditActionOption!]!

FieldKiểuMô tả
actionString!
categoryStringRegistry module; null for an action only written by SQL.
severityAuditSeverity

auditEvent ​

One audit event; not_found when there is none. Requires audit.read.

query · quyền: audit.read

Tham sốKiểuMặc địnhMô tả
idID!

Trả về AuditEventDetail!

FieldKiểuMô tả
idID!
occurredAtDateTime!
actorAuditActor
actionString!
categoryString
severityAuditSeverity
outcomeAuditOutcome!
entityAuditEntityRef!
requestIdString
hasDetailBoolean!
operationStringGraphQL mutation that wrote the row; null for rows written by SQL.
correlationIdString!
reasonStringDenial reason or the reason the actor gave, as stored (masked).
entityIds[String!]!Every target id, masked when written.
entityVersionIntVersion of the target after the command; null for denials and versionless events.
clientIpStringClient address cut when read: IPv4 /24, IPv6 /48 (DEC-CV3-35); the log stores it whole. Null when not an address.
userAgentString
beforeStringJSON text (an object) of the before as stored (masked; a summary when hasDetail).
afterStringJSON text (an object) of the after as stored (masked; a summary when hasDetail).
metadataString!JSON text (an object) of the stored metadata (masked input, severity, flags).
maskedPaths[String!]!Paths whose raw value changed but read the same once masked (metadata.maskedChanges).

auditEventFullChange ​

Full before / after of an audit event flagged metadata.hasDetail. Null when the event has none (or is unknown). Requires audit.read.

query · quyền: audit.read

Tham sốKiểuMặc địnhMô tả
auditEventIdID!

Trả về AuditEventFullChange

FieldKiểuMô tả
auditEventIdID!
recordedAtDateTime!
beforeStringJSON text (an object) of the full before, masked like the audit row; null when the row already holds it whole.
afterStringJSON text (an object) of the full after, masked like the audit row; null when the row already holds it whole.
beforeBytesIntUTF-8 bytes of the full before as JSON; null with a null before.
afterBytesIntUTF-8 bytes of the full after as JSON; null with a null after.
completeBoolean!False when a side was larger than 4 MiB of JSON: that side keeps only {truncated, keys, bytes}.

auditEvents ​

The audit log, newest first, pages of at most 100 rows. Requires audit.read (DEC-CV3-33).

query · quyền: audit.read

Tham sốKiểuMặc địnhMô tả
filterAuditEventFilter
pageInt1
pageSizeInt50

Trả về AuditEventPage!

FieldKiểuMô tả
items[AuditEventSummary!]!
totalInt!
pageInt!
pageSizeInt!
scopeAuditScope!

Sinh từ ad83b0aea · 820 migration · PostgreSQL 17