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\Model\UserSftpClientUse::list;

Return Object

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

try {
  $user_sftp_client_uses = \Files\Model\UserSftpClientUse::list([
    'user_id' => 1
  ]);
  foreach ($user_sftp_client_uses as $user_sftp_client_use) {
    // Operate on $user_sftp_client_use
  }
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

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