Skip to main content

audit

View audit logs for workspace activity. Audit logs track all actions performed in a workspace for compliance and security monitoring.

zopp audit <COMMAND>
note

Audit log commands require admin permission on the workspace.

Commands

CommandDescription
listList audit log entries
getGet details of a specific audit entry
countCount audit log entries

audit list

List audit log entries for a workspace.

zopp audit list [OPTIONS] -w <WORKSPACE>

Options

OptionRequiredDescription
-w, --workspace <WORKSPACE>YesWorkspace name
--limit <LIMIT>NoMaximum entries to return (default: 50)
--action <ACTION>NoFilter by action type
--result <RESULT>NoFilter by result (success/denied)
-h, --helpNoPrint help

Action Types

ActionDescription
secret.readSecret was read
secret.writeSecret was created or updated
secret.deleteSecret was deleted
principal.createPrincipal was created
principal.deletePrincipal was deleted
permission.grantPermission was granted
permission.revokePermission was revoked
invite.createInvite was created
invite.consumeInvite was used

Example

$ zopp audit list -w mycompany --limit 10

Audit logs (10 of 247 total):

ID: 550e8400-e29b-41d4-a716-446655440000
Timestamp: 2024-01-10T14:30:00Z
Action: secret.read
Resource: secret (backend/prod/DATABASE_URL)
Result: success

ID: 550e8400-e29b-41d4-a716-446655440001
Timestamp: 2024-01-10T14:25:00Z
Action: secret.write
Resource: secret (backend/dev/API_KEY)
Result: success

audit get

Get detailed information about a specific audit log entry.

zopp audit get -w <WORKSPACE> <ENTRY_ID>

Arguments

ArgumentRequiredDescription
ENTRY_IDYesAudit entry ID

Options

OptionRequiredDescription
-w, --workspace <WORKSPACE>YesWorkspace name

Example

$ zopp audit get -w mycompany 550e8400-e29b-41d4-a716-446655440000

ID: 550e8400-e29b-41d4-a716-446655440000
Timestamp: 2024-01-10T14:30:00Z
Principal ID: 660e8400-e29b-41d4-a716-446655440000
User ID: 770e8400-e29b-41d4-a716-446655440000
Action: secret.read
Resource: secret (backend/production/DATABASE_URL)
Workspace: 880e8400-e29b-41d4-a716-446655440000
Project: 990e8400-e29b-41d4-a716-446655440000
Environment: aa0e8400-e29b-41d4-a716-446655440000
Result: success
Client IP: 192.168.1.100

audit count

Count audit log entries matching criteria.

zopp audit count [OPTIONS] -w <WORKSPACE>

Options

OptionRequiredDescription
-w, --workspace <WORKSPACE>YesWorkspace name
--action <ACTION>NoFilter by action type
--result <RESULT>NoFilter by result (success/denied)

Example

$ zopp audit count -w mycompany --action secret.read
Total audit log entries: 1247