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

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

import UserSecurityEvent from 'files.com/lib/models/UserSecurityEvent';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const userSecurityEvents = await UserSecurityEvent.list();
  for (const userSecurityEvent of userSecurityEvents) {
    // Operate on userSecurityEvent
  }
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

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

import UserSecurityEvent from 'files.com/lib/models/UserSecurityEvent';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const userSecurityEvent = await UserSecurityEvent.find(id);
  // Operate on userSecurityEvent
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

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.