User Security Events

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

List User Security Events

SDK Method

files_sdk.user_security_event.list()

Return Object

ListObj[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 files_sdk

try:
  user_security_events = files_sdk.user_security_event.list()
  for user_security_event in user_security_events.auto_paging_iter():
    # Operate on user_security_event
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

Show User Security Event

SDK Method

files_sdk.user_security_event.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 files_sdk

try:
  user_security_event = files_sdk.user_security_event.find(id)
  # Operate on user_security_event
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", 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.