User Security Events

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

List User Security Events

SDK Method

Files::UserSecurityEvent.list

Return Object

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

begin
  user_security_events = Files::UserSecurityEvent.list
  user_security_events.auto_paging_each do |user_security_event|
    # Operate on user_security_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 User Security Event

SDK Method

Files::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

begin
  user_security_event = Files::UserSecurityEvent.find(id)
  # Operate on user_security_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 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.