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

Return Object

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

import files_sdk

try:
  desktop_configuration_profiles = files_sdk.desktop_configuration_profile.list()
  for desktop_configuration_profile in desktop_configuration_profiles.auto_paging_iter():
    # Operate on desktop_configuration_profile
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)

Show Desktop Configuration Profile

SDK Method

files_sdk.desktop_configuration_profile.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

import files_sdk

try:
  desktop_configuration_profile = files_sdk.desktop_configuration_profile.find(id)
  # Operate on desktop_configuration_profile
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)

Create Desktop Configuration Profile

SDK Method

files_sdk.desktop_configuration_profile.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

import files_sdk

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

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

import files_sdk

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

Delete Desktop Configuration Profile

SDK Method

desktop_configuration_profile.delete()

Return Object

No return value.

Authorization Requirement

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

Example Request

import files_sdk

try:
  # Find the desktop_configuration_profile object by its id.
  desktop_configuration_profile = files_sdk.desktop_configuration_profile.find(id)
  desktop_configuration_profile.delete()
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 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.