QlikElixir.REST.Audits (qlik_elixir v0.3.5)

View Source

REST API client for Qlik Cloud Audits.

Provides functions to query audit logs for compliance and monitoring.

Examples

# List recent audit events
{:ok, %{"data" => events}} = Audits.list(config: config)

# Filter by event type
{:ok, %{"data" => events}} = Audits.list(config: config, event_type: "com.qlik.v1.app.created")

# Get event details
{:ok, event} = Audits.get("audit-123", config: config)

# List available sources and types
{:ok, sources} = Audits.list_sources(config: config)
{:ok, types} = Audits.list_types(config: config)

Summary

Functions

get(audit_id, opts \\ [])

Gets an audit event by ID.

get_settings(opts \\ [])

Gets audit settings for the tenant.

list(opts \\ [])

Lists audit events.

list_sources(opts \\ [])

Lists available audit sources.

list_types(opts \\ [])

Lists available audit event types.

Functions

get(audit_id, opts \\ [])

@spec get(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, QlikElixir.Error.t()}

Gets an audit event by ID.

get_settings(opts \\ [])

@spec get_settings(keyword()) :: {:ok, map()} | {:error, QlikElixir.Error.t()}

Gets audit settings for the tenant.

list(opts \\ [])

@spec list(keyword()) :: {:ok, map()} | {:error, QlikElixir.Error.t()}

Lists audit events.

Options

  • :config - Required. The configuration struct.
  • :limit - Maximum number of results per page.
  • :next - Cursor for pagination.
  • :event_type - Filter by event type (e.g., "com.qlik.v1.app.created").
  • :user_id - Filter by user ID.
  • :source - Filter by source (e.g., "com.qlik").

list_sources(opts \\ [])

@spec list_sources(keyword()) :: {:ok, map()} | {:error, QlikElixir.Error.t()}

Lists available audit sources.

list_types(opts \\ [])

@spec list_types(keyword()) :: {:ok, map()} | {:error, QlikElixir.Error.t()}

Lists available audit event types.