Giao diện
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!]!
| Field | Kiểu | Mô tả |
|---|---|---|
action | String! | |
category | String | Registry module; null for an action only written by SQL. |
severity | AuditSeverity |
auditEvent
One audit event; not_found when there is none. Requires audit.read.
query · quyền: audit.read
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
id | ID! |
Trả về AuditEventDetail!
| Field | Kiểu | Mô tả |
|---|---|---|
id | ID! | |
occurredAt | DateTime! | |
actor | AuditActor | |
action | String! | |
category | String | |
severity | AuditSeverity | |
outcome | AuditOutcome! | |
entity | AuditEntityRef! | |
requestId | String | |
hasDetail | Boolean! | |
operation | String | GraphQL mutation that wrote the row; null for rows written by SQL. |
correlationId | String! | |
reason | String | Denial reason or the reason the actor gave, as stored (masked). |
entityIds | [String!]! | Every target id, masked when written. |
entityVersion | Int | Version of the target after the command; null for denials and versionless events. |
clientIp | String | Client address cut when read: IPv4 /24, IPv6 /48 (DEC-CV3-35); the log stores it whole. Null when not an address. |
userAgent | String | |
before | String | JSON text (an object) of the before as stored (masked; a summary when hasDetail). |
after | String | JSON text (an object) of the after as stored (masked; a summary when hasDetail). |
metadata | String! | 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ểu | Mặc định | Mô tả |
|---|---|---|---|
auditEventId | ID! |
Trả về AuditEventFullChange
| Field | Kiểu | Mô tả |
|---|---|---|
auditEventId | ID! | |
recordedAt | DateTime! | |
before | String | JSON text (an object) of the full before, masked like the audit row; null when the row already holds it whole. |
after | String | JSON text (an object) of the full after, masked like the audit row; null when the row already holds it whole. |
beforeBytes | Int | UTF-8 bytes of the full before as JSON; null with a null before. |
afterBytes | Int | UTF-8 bytes of the full after as JSON; null with a null after. |
complete | Boolean! | 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ểu | Mặc định | Mô tả |
|---|---|---|---|
filter | AuditEventFilter | ||
page | Int | 1 | |
pageSize | Int | 50 |
Trả về AuditEventPage!
| Field | Kiểu | Mô tả |
|---|---|---|
items | [AuditEventSummary!]! | |
total | Int! | |
page | Int! | |
pageSize | Int! | |
scope | AuditScope! |