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

Files::UserSftpClientUse.list

Return Object

List<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

begin
  user_sftp_client_uses = Files::UserSftpClientUse.list(
    user_id: 1
  )
  user_sftp_client_uses.auto_paging_each do |user_sftp_client_use|
    # Operate on user_sftp_client_use
  end
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

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