Star Quix Streams

 Install Quix Streams

 Edit on GitHub

cloud users audit

Overview

Get the auditing details of the users of your organization

Aliases: audit

Usage:

quix cloud users audit [<start> [<end>]] [options]

Arguments:

• <start> : Start of audit period. Default to the beginning of the current day if not specified. Supports natural language (e.g., 'yesterday', 'last monday', 'may 27th', '2024-04-24') and ISO 8601 timestamps ('YYYY-MM-DD HH:MM:SS.sss'). [default: yesterday]
• <end> : End of audit period. Default to the current time if not specified. Supports natural language and precise timestamps. [default: today]

Options:

• -o, --output <json|table> : Output type of the retrieved data
• --email <email> : Email address of the user to fetch audit details for.
• -s, --page-size <page-size> : Specifies the number of records to display per page. [default: 50]
• -p, --page <page> : Determines the page number from which to start displaying records. [default: 1]
• -k, --key <key> : Specifies the keys for the parameters. The number of keys must match the number of values.
• -v, --value <value> : Specifies the values for the parameters. The number of values must match the number of keys.
• --exclude-parameters : Excludes the parameters from being rendering in the table

How It Works

1. Email Filtering:

   • You can specify an email address to fetch audit details for a particular user.

2. Time Range Specification:

   • The command allows you to define the start and end of the audit period using natural language or ISO 8601 timestamps.

3. Pagination and Output Customization:

   • You can control the number of records per page and the page number to start displaying from.
   • The command supports output customization, including JSON format and exclusion of parameters from the output.

4. Key-Value Filtering:

   • You can specify keys and values to filter the audit records.

Example Usage

$ quix cloud user audit --email user@quix.io "06/12/2024" "06/13/2024" -s 3 -p 1
Auditing data from 06/12/2024 00:00:00 to 06/13/2024 00:00:00
Page: 1

Email           | Controller | Action          | Parameters                   | UTC Time
----------------|------------|-----------------|------------------------------|----------------------------------
user@quix.io    | Workspace  | Sync            | workspaceId: quix-proja-envx | 2024-06-12T11:10:07.8200000+00:00
user@quix.io    | Repository | GenerateSshKeys |                              | 2024-06-12T11:21:21.6670000+00:00
user@quix.io    | Repository | Create          |                              | 2024-06-12T11:21:34.0350000+00:00

Press any key to continue to the next page (Press ESC to exit)

You can also filter the parameters. For example, to filter by workspaceId:

quix cloud user audit --email user@quix.io "06/12/2024" "06/13/2024" -s 3 -p 1 -k workspaceId -v quix-proja-envx
Auditing data from 06/12/2024 00:00:00 to 06/13/2024 00:00:00
Page: 1

Email           | Controller | Action           | Parameters                           | UTC Time
----------------|------------|------------------|--------------------------------------|----------------------------------
user@quix.io    | Workspace  | UpdateDescriptor | workspaceId: quix-proja-envx         | 2024-06-12T11:24:38.4490000+00:00
                |            |                  | commitMessage: Edited 'quix.yaml'    |
user@quix.io    | Workspace  | Sync             | workspaceId: quix-proja-envx         | 2024-06-12T11:24:56.9710000+00:00
user@quix.io    | Workspace  | Sync             | workspaceId: quix-proja-envx         | 2024-06-12T11:25:13.2770000+00:00

Press any key to continue to the next page (Press ESC to exit)