Skip to main content
Manage audit contexts For a detailed overview, please visit the audit context’s reference page.

auditctx access-report

Show the access report for the referenced audit context Usage
Common Options Reference

auditctx audit

Retrieve audit trail events for the referenced audit context Usage
Common Options Reference

auditctx clone

Create a clone of the referenced audit context; this will only duplicate its spec. Usage
Common Options Reference

auditctx create

Create a new audit context Usage
Common Options Reference

auditctx edit

Edit the referenced audit context, as YAML, within an editor Usage
The default editor can be set by using the EDITOR environment variable.
Common Options Reference

auditctx eventlog

Show the event log of the referenced audit context Usage
Common Options Reference

auditctx get

Retrieve one or more referenced audit contexts Usage
An empty reference will return all references
Common Options Reference
  • Get all audit contexts
  • Get one audit context
  • Get multiple audit contexts

auditctx patch

Update the referenced audit context’s metadata using an input file Usage
Running this command with the option --file - sets the input to stdin. The input is required to be a valid JSON or YAML string (e.g., {"description": "My new description"} or description: My new description). To complete the update, press Control-D (or Control-Z if you are using Windows).
Common Options Reference

auditctx permissions

Show the grantable permissions for an audit context object type Usage
Common Options Reference

auditctx query

Find all the audit contexts based on the given query Usage
Common Options Reference
Use the --match option to display all, none, or any of the results based on a given property or tag
  • Search for an audit context based on the name property
  • Search for an audit context based on the description property
  • Search for an audit context based on a tag
  • Search for an audit context based on a property and tag

auditctx tag

Manage the tags belonging to one or more referenced audit contexts Usage
Built-in tags, which begin with cpln/*, can’t be modified.
Common Options Reference
  • Add a tag
  • Update same tag (after running the example above)
  • Remove tag (after running the example above)

auditctx update

Update properties of the referenced audit context Usage
Common Options Reference
  • The --set option allows the modification of the following audit context properties:
    • description
      • Description of the audit context
      • Type: string
    • tags
      • Tags (key=value) associated with the audit context
      • Type: string
  • For the examples below, the initial audit context is configured as:
  • Update an audit context’s description
  • Update an audit context’s tag