Desktop Configuration Profiles

A Desktop Configuration Profile centrally defines desktop mount point mappings for users in a Site or Workspace.

List Desktop Configuration Profiles

SDK Method

Files::DesktopConfigurationProfile.list

Return Object

List<DesktopConfigurationProfile>

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

begin
  desktop_configuration_profiles = Files::DesktopConfigurationProfile.list
  desktop_configuration_profiles.auto_paging_each do |desktop_configuration_profile|
    # Operate on desktop_configuration_profile
  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

Show Desktop Configuration Profile

SDK Method

Files::DesktopConfigurationProfile.find

Return Object

DesktopConfigurationProfile

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
id
int64
Required		Desktop Configuration Profile ID.

Example Request

begin
  desktop_configuration_profile = Files::DesktopConfigurationProfile.find(id)
  # Operate on desktop_configuration_profile
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

Create Desktop Configuration Profile

SDK Method

Files::DesktopConfigurationProfile.create

Return Object

DesktopConfigurationProfile

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDefaultDescription
name
string
Required		Profile name
mount_mappings
object
Required		Mount point mappings for the desktop app. Keys must be a single uppercase Windows drive letter other than A, B, or C, and values are Files.com paths to mount there.
workspace_id
int64		0Workspace ID
use_for_all_users
boolean		falseWhether this profile applies to all users in the Workspace by default
disable_drive_mounting
boolean		falseWhether the desktop app should hide drive mounting, prevent new drive mounts, and unmount active drive mounts for users with this profile

Example Request

begin
  desktop_configuration_profile = Files::DesktopConfigurationProfile.create(
    name: "North America Desktop Profile",
    mount_mappings: {"key":"example value"}
  )
  # Operate on desktop_configuration_profile
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

Update Desktop Configuration Profile

SDK Method

desktop_configuration_profile.update

Return Object

DesktopConfigurationProfile

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
name
string		Profile name
workspace_id
int64		Workspace ID
mount_mappings
object		Mount point mappings for the desktop app. Keys must be a single uppercase Windows drive letter other than A, B, or C, and values are Files.com paths to mount there.
use_for_all_users
boolean		Whether this profile applies to all users in the Workspace by default
disable_drive_mounting
boolean		Whether the desktop app should hide drive mounting, prevent new drive mounts, and unmount active drive mounts for users with this profile

Example Request

begin
  # Find the desktop_configuration_profile object by its id.
  desktop_configuration_profile = Files::DesktopConfigurationProfile.find(id)
  desktop_configuration_profile.update(
    name: "North America Desktop Profile"
  )
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

Delete Desktop Configuration Profile

SDK Method

desktop_configuration_profile.delete

Return Object

nil

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Example Request

begin
  # Find the desktop_configuration_profile object by its id.
  desktop_configuration_profile = Files::DesktopConfigurationProfile.find(id)
  desktop_configuration_profile.delete
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 DesktopConfigurationProfile Object

Some of the methods above return a DesktopConfigurationProfile object. The attributes of this object are listed below.

AttributeDescription
id
int64		Desktop Configuration Profile ID
name
string		Profile name
workspace_id
int64		Workspace ID
use_for_all_users
boolean		Whether this profile applies to all users in the Workspace by default
disable_drive_mounting
boolean		Whether the desktop app should hide drive mounting, prevent new drive mounts, and unmount active drive mounts for users with this profile
mount_mappings
object		Mount point mappings for the desktop app. Keys must be a single uppercase Windows drive letter other than A, B, or C, and values are Files.com paths to mount there.