User SFTP Client Uses

A UserSftpClientUse is a way to see the exact set of SFTP clients used by a given user.

List User SFTP Client Uses

SDK Method

user_sftp_client_use.List()

Return Values

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

Authorization Requirement

Not available to user API keys or sessions from users that are marked as Shared/Bot users.

UserSftpClientUseListParams Fields

Field	Description
UserId int64	User ID. If provided, will return uses for this user.

Additional Arguments

Example Request

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    user_sftp_client_use "github.com/Files-com/files-sdk-go/v3/usersftpclientuse"
)

userSftpClientUseIterator, err := user_sftp_client_use.List(files_sdk.UserSftpClientUseListParams{UserId: 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
}

for userSftpClientUse, err := range userSftpClientUseIterator.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(userSftpClientUse)
}

The UserSftpClientUse Object

Some of the methods above return a UserSftpClientUse object. The attributes of this object are listed below.

Attribute	Description
Id int64	UserSftpClientUse ID
SftpClient string	The SFTP client used
CreatedAt date-time	The earliest recorded use of this SFTP client (for this user)
UpdatedAt date-time	The most recent use of this SFTP client (for this user)
UserId int64	ID of the user who performed this access