User Cipher Uses

A UserCipherUse is a way to see the exact set of encryption ciphers and protocols used by a given user. This is most often used to support migrations from one TLS version to the next. You can query each user and determine who is still using legacy ciphers.

List User Cipher Uses

SDK Function

UserCipherUse.list()

Return Object

ListIterator<UserCipherUse>

Authorization Requirement

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

Function Arguments

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

Additional Arguments

Example Request

import com.files.ListIterator;
import com.files.exceptions.*;
import com.files.exceptions.ApiErrorException.*;
import com.files.models.UserCipherUse;

try {
  HashMap<String, Object> parameters = new HashMap<>();
  parameters.put("user_id", 1);
  
  ListIterator<UserCipherUse> userCipherUses = UserCipherUse.list(parameters);
  for (UserCipherUse userCipherUse : userCipherUses.listAutoPaging()) {
    // Operate on userCipherUse
  }
} catch (NotAuthenticatedException e) {
  System.out.println("Authentication Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
} catch (SdkException e) {
  System.out.println("Unknown Error Occurred (" + e.getClass().getName() + "): " + e.getMessage());
}

The UserCipherUse Object

Some of the functions above return a UserCipherUse object. The attributes of this object are listed below.

Attribute	Description
id int64	UserCipherUse ID
user_id int64	ID of the user who performed this access
username string	Username of the user who performed this access
protocol_cipher string	The protocol and cipher employed
created_at date-time	The earliest recorded use of this combination of interface and protocol and cipher (for this user)
insecure boolean	Is this cipher considered insecure?
interface string	The interface accessed Possible values: `web`, `ftp`, `sftp`, `dav`, `desktop`, `restapi`, `robot`, `jsapi`, `inbound_s3`
updated_at date-time	The most recent use of this combination of interface and protocol and cipher (for this user)