User Security Events

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

List User Security Events

Command

files-cli user-security-events list

Output

Outputs a list of UserSecurityEvent objects according to the output format.

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

files-cli user-security-events list

Show User Security Event

Command

files-cli user-security-events find

Output

Outputs a UserSecurityEvent object according to the output format.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Flags

FlagDescription
--id=
int64
Required
User Security Event ID.

Example Request

files-cli user-security-events find \
  --id=1

The UserSecurityEvent Object

Some of the commands 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.