Class: PlatformAPI::AuditTrailEvent

Inherits:
Object
  • Object
show all
Defined in:
lib/platform-api/client.rb

Overview

An audit trail event represents some action on the platform

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ AuditTrailEvent

Returns a new instance of AuditTrailEvent.



1513
1514
1515
# File 'lib/platform-api/client.rb', line 1513

def initialize(client)
  @client = client
end

Instance Method Details

#list(enterprise_account_id) ⇒ Object

List existing events. Returns all events for one date, defaulting to current date. Order, actor, action, and type, and date query params can be specified as query parameters. For example, '/enterprise-accounts/:id/events?order=desc&actor=user@example.com&action=create&type=app&date=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:

    unique identifier of the enterprise account



1520
1521
1522
# File 'lib/platform-api/client.rb', line 1520

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