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_sdk.user_sftp_client_use.list()

Return Object

ListObj[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

import files_sdk

try:
  user_sftp_client_uses = files_sdk.user_sftp_client_use.list({
    "user_id": 1
  })
  for user_sftp_client_use in user_sftp_client_uses.auto_paging_iter():
    # Operate on user_sftp_client_use
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

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