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

UserSftpClientUse.List();

Return Object

FilesList<UserSftpClientUse>

Authorization Requirement

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

Method Arguments

Argument	Description
user_id int64	User ID. If provided, will return uses for this user.

Additional Arguments

Example Request

using FilesCom.Models;

var parameters = new Dictionary<string, object>();
parameters.Add("user_id", (Int64?) 1);

try
{
    var userSftpClientUseIterator = UserSftpClientUse.List(parameters);
    foreach (UserSftpClientUse userSftpClientUse in userSftpClientUseIterator.ListAutoPaging()) {
        // Operate on userSftpClientUse
    }
}
catch (FilesCom.NotAuthenticatedException e)
{
    Console.WriteLine($"Authentication Error Occurred ({e.GetType().Name}): " + e.Message);
}
catch (FilesCom.SdkException e)
{
    Console.WriteLine($"Unknown Error Occurred ({e.GetType().Name}): " + e.Message);
}

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
sftp_client string	The SFTP client used
created_at date-time	The earliest recorded use of this SFTP client (for this user)
updated_at date-time	The most recent use of this SFTP client (for this user)
user_id int64	ID of the user who performed this access