Class: PlatformAPI::AuditTrailEvent

Inherits:

Object

• Object
• PlatformAPI::AuditTrailEvent

Defined in:

lib/platform-api/client.rb

Overview

An audit trail event represents some action on the platform

Instance Method Summary

• #initialize(client) ⇒ AuditTrailEvent constructor

  A new instance of AuditTrailEvent.

• #list(enterprise_account_id_or_enterprise_account_name) ⇒ Object

  List existing events.

Constructor Details

#initialize(client) ⇒ AuditTrailEvent

Returns a new instance of AuditTrailEvent.

# File 'lib/platform-api/client.rb', line 1511

def initialize(client)
  @client = client
end

Instance Method Details

#list(enterprise_account_id_or_enterprise_account_name) ⇒ Object

List existing events. Returns all events for one day, defaulting to current day. Order, actor, action, and type, and day query params can be specified as query parameters. For example, '/enterprise-accounts/:id/events?order=desc&actor=user@example.com&action=create&type=app&day=2020-09-30' would return events in descending order and only return app created events by the user with user@example.com email address.

Parameters:

• enterprise_account_id_or_enterprise_account_name: —

  unique identifier of the enterprise account or unique name of the enterprise account

# File 'lib/platform-api/client.rb', line 1518

def list(enterprise_account_id_or_enterprise_account_name)
  @client.audit_trail_event.list(enterprise_account_id_or_enterprise_account_name)
end