openapi/audit-components.yml at develop · Sphereon-Opensource/openapi · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
openapi: 3.0.4
info:
  title: Audit API Components
  version: 0.1.0
  description: Entity schemas for the immutable audit query REST API.
paths: {}
components:
  schemas:
    AuditEventResult:
      type: string
      description: Result status of an audited command execution.
      enum: [started, succeeded, failed, policy_denied, auth_failure, warning]
      example: succeeded

    AuditEvent:
      type: object
      description: Immutable EDK audit event as persisted by the VDX audit store.
      required: [eventId, commandId, command, result, timestamp, metadata]
      properties:
        eventId:
          type: string
          description: Stable audit event row identifier generated by the immutable audit store.
          example: 018fe3d2-07aa-7451-83d4-a73ef4f6ac6a
        commandId:
          type: string
          description: Canonical audited command identifier.
          example: tenant.admin.register
        command:
          type: string
          description: Command name stored with the audit event.
          example: register
        actorId:
          type: string
          nullable: true
          description: Actor/principal identifier, when known.
        subjectId:
          type: string
          nullable: true
          description: Subject identifier, when the event targets a subject.
        resourceId:
          type: string
          nullable: true
          description: Resource identifier, when the event targets a resource.
        result:
          $ref: '#/components/schemas/AuditEventResult'
        timestamp:
          type: integer
          format: int64
          description: Event timestamp in epoch milliseconds.
        correlationId:
          type: string
          nullable: true
          description: Correlation identifier associated with the command execution.
        tenantId:
          type: string
          nullable: true
          description: Tenant scope stored with the event.
        durationMs:
          type: integer
          format: int64
          nullable: true
          description: Command execution duration in milliseconds, when recorded.
        traceId:
          type: string
          nullable: true
          description: W3C trace identifier, when available.
        spanId:
          type: string
          nullable: true
          description: W3C span identifier, when available.
        errorCode:
          type: string
          nullable: true
          description: Stable error code for failed events, when available.
        errorMessage:
          type: string
          nullable: true
          description: Redacted error message for failed events, when available.
        transportType:
          type: string
          nullable: true
          description: Transport that emitted the audit event.
          example: http
        transportScope:
          type: string
          nullable: true
          description: Transport scope that emitted the audit event.
          example: platform-admin
        metadata:
          type: object
          additionalProperties:
            type: string
          default: {}
          description: Redacted string metadata captured with the event.

    AuditEventList:
      type: object
      description: Offset/limit audit event query result.
      required: [data, limit, offset]
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AuditEvent'
          default: []
        limit:
          type: integer
          minimum: 1
          maximum: 1000
          description: Effective limit used by the query.
        offset:
          type: integer
          minimum: 0
          description: Effective offset used by the query.