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 (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    user_security_event "github.com/Files-com/files-sdk-go/v3/usersecurityevent"
)

userSecurityEventIterator, err := user_security_event.List(files_sdk.UserSecurityEventListParams{})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

for userSecurityEventIterator.Next() {
    userSecurityEvent := userSecurityEventIterator.userSecurityEvent()
}
err = userSecurityEventIterator.Err()
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

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.

UserSecurityEventFindParams Fields

FieldDescription
Id
int64
Required		User Security Event ID.

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    user_security_event "github.com/Files-com/files-sdk-go/v3/usersecurityevent"
)

userSecurityEvent, err := user_security_event.Find(files_sdk.UserSecurityEventFindParams{Id: 1})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

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
EventType
string		Type of user security event being recorded.
Possible values: lockout
Body
string		Event body.
EventErrors
array(string)		Event errors.
CreatedAt
date-time		Event create date/time.
BodyUrl
string		Link to log file.
UserId
int64		User ID.