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

ExternalEvent.List();

Return Object

FilesList<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

using FilesCom.Models;

try
{
    var externalEventIterator = ExternalEvent.List();
    foreach (ExternalEvent externalEvent in externalEventIterator.ListAutoPaging()) {
        // Operate on externalEvent
    }
}
catch (FilesCom.NotAuthenticatedException e)
{
    Console.WriteLine($"Authentication Error Occurred ({e.GetType().Name}): " + e.Message);
}
catch (FilesCom.SdkException e)
{
    Console.WriteLine($"Unknown Error Occurred ({e.GetType().Name}): " + e.Message);
}

Show External Event

SDK Method

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

using FilesCom.Models;

try
{
    var externalEvent = await ExternalEvent.Find(id);
    // Operate on externalEvent
}
catch (FilesCom.NotAuthenticatedException e)
{
    Console.WriteLine($"Authentication Error Occurred ({e.GetType().Name}): " + e.Message);
}
catch (FilesCom.SdkException e)
{
    Console.WriteLine($"Unknown Error Occurred ({e.GetType().Name}): " + e.Message);
}

Create External Event

SDK Method

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

using FilesCom.Models;

var parameters = new Dictionary<string, object>();
parameters.Add("status", "example");
parameters.Add("body", "example");

try
{
    var externalEvent = await ExternalEvent.Create(parameters);
    // Operate on externalEvent
}
catch (FilesCom.NotAuthenticatedException e)
{
    Console.WriteLine($"Authentication Error Occurred ({e.GetType().Name}): " + e.Message);
}
catch (FilesCom.SdkException e)
{
    Console.WriteLine($"Unknown Error Occurred ({e.GetType().Name}): " + e.Message);
}

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.