Skip to main content
Version: 1.4.x

Audit

AuditService

The Audit Service provides access to the Service Bridge audit log APIs.

All operations performed against TSB resources generate audit log events that can be queried using the Audit log APIs. Those events include information about the users that performed each action and about the actions themselves.

This API is integrated with the TSB permission system, and all its methods will only return audit logs for those resources the users making the queries have permissions on.

ListAuditLogs

List audit logs. If no 'count' parameter has been specified, the last 25 audit logs are returned. This method will only return audit logs for those resources the user making the query has permissions on.

AuditLog

AuditLog

A system log describing something that happened in the system.

FieldDescriptionValidation Rule

createTime

google.protobuf.Timestamp
Time when the audit log was generated.

timestamp = {
  required: true
}

severity

string
Log severity (INFO, WARN, ERROR...).

string = {
  min_len: 1
}

kind

string
The kind of the audit log (PolicyAssigned, ServiceOrphaned, etc).

string = {
  min_len: 1
}

message

string
Audit log details.

string = {
  min_len: 1
}

triggeredBy

string
Person who triggered the audit log, or "SYSTEM" if the log was automatically triggered by the system.

string = {
  min_len: 1
}

properties

map<string, string>
Key value pairs with additional information for the audit log.

fqn

string
Fully-qualified name of object that made this record.

operation

string
Operation that was performed on the resource.

ListAuditLogsRequest

Request to get the audit logs.

FieldDescriptionValidation Rule

count

int32
Number of audit logs to retrieve. By default is 25.

sinceTimestamp

google.protobuf.Timestamp
Moment in time since we retrieve logs.

severity

string
Severity level to filter logs.

kind

string
The kind of the audit log to filter (PolicyAssigned, ServiceOrphaned, etc).

triggeredBy

string
Filter by what triggered the event.

text

string
Text to filter by.

recursive

bool
If set to true, the audit log search will include the logs for all child resources for the one configured in the fqn field

operation

string
Operation that was performed on the resource.

ListAuditLogsResponse

The list of audit logs.

FieldDescriptionValidation Rule

auditLogs

List of tetrateio.api.audit.v1.AuditLog