External Events

An ExternalEvent is a log that is sent to the cloud from a client application such as the Files.com CLI.

List External Events

SDK Method

Files::ExternalEvent.list

Return Object

List<ExternalEvent>

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

begin
  external_events = Files::ExternalEvent.list
  external_events.auto_paging_each do |external_event|
    # Operate on external_event
  end
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Show External Event

SDK Method

Files::ExternalEvent.find

Return Object

ExternalEvent

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
id
int64
Required		External Event ID.

Example Request

begin
  external_event = Files::ExternalEvent.find(id)
  # Operate on external_event
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Create External Event

SDK Method

Files::ExternalEvent.create

Return Object

ExternalEvent

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
status
string
Required		Status of event.
Possible values: success, failure, partial_failure, in_progress, skipped
body
string
Required		Event body

Example Request

begin
  external_event = Files::ExternalEvent.create(
    status: "example",
    body: "example"
  )
  # Operate on external_event
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

The ExternalEvent Object

Some of the methods above return a ExternalEvent object. The attributes of this object are listed below.

AttributeDescription
id
int64		Event ID
event_type
string		Type of event being recorded.
Possible values: ldap_sync, remote_server_sync, lockout, ldap_login, saml_login, client_log, pending_work, siem_http_destination
status
string		Status of event.
Possible values: success, failure, partial_failure, in_progress, skipped
body
string		Event body
created_at
date-time		External event create date/time
body_url
string		Link to log file.