User Security Events

A UserSecurityEvent is a log record for user security activity such as user lockouts.

List User Security Events

SDK Method

UserSecurityEvent.List();

Return Object

FilesList<UserSecurityEvent>

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 userSecurityEventIterator = UserSecurityEvent.List();
    foreach (UserSecurityEvent userSecurityEvent in userSecurityEventIterator.ListAutoPaging()) {
        // Operate on userSecurityEvent
    }
}
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 User Security Event

SDK Method

UserSecurityEvent.Find();

Return Object

UserSecurityEvent

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		User Security Event ID.

Example Request

using FilesCom.Models;

try
{
    var userSecurityEvent = await UserSecurityEvent.Find(id);
    // Operate on userSecurityEvent
}
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 UserSecurityEvent Object

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

AttributeDescription
id
int64		Event ID
event_type
string		Type of user security event being recorded.
Possible values: lockout
body
string		Event body.
event_errors
array(string)		Event errors.
created_at
date-time		Event create date/time.
body_url
string		Link to log file.
user_id
int64		User ID.