User Security Events

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

List User Security Events

SDK Method

user_security_event.List()

Return Values

Returns a *user_security_event.Iter and an error. Range over All() to receive files_sdk.UserSecurityEvent values and errors. Check each loop error before using its resource. Next() and Err() remain supported.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator.

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.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
    } else {
        fmt.Printf("Request failed: %v\n", err)
    }
    return
}

for userSecurityEvent, err := range userSecurityEventIterator.All() {
    if err != nil {
        var respErr files_sdk.ResponseError
        if errors.As(err, &respErr) {
            fmt.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
        } else {
            fmt.Printf("Request failed: %v\n", err)
        }
        return
    }
    fmt.Println(userSecurityEvent)
}

Show User Security Event

SDK Method

user_security_event.Find()

Return Values

Returns a files_sdk.UserSecurityEvent value and an error.

Authorization Requirement

Requires a Site-Wide API key, or a User API key or session from a Site Administrator.

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.Printf("API error (%s): %s\n", respErr.Type, respErr.ErrorMessage)
    } else {
        fmt.Printf("Request failed: %v\n", err)
    }
    return
}
fmt.Println(userSecurityEvent)

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.