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

DesktopConfigurationProfile.list()

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.

Additional Arguments

Example Request

import DesktopConfigurationProfile from 'files.com/lib/models/DesktopConfigurationProfile';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const desktopConfigurationProfiles = await DesktopConfigurationProfile.list();
  for (const desktopConfigurationProfile of desktopConfigurationProfiles) {
    // Operate on desktopConfigurationProfile
  }
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Show Desktop Configuration Profile

SDK Method

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

import DesktopConfigurationProfile from 'files.com/lib/models/DesktopConfigurationProfile';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const desktopConfigurationProfile = await DesktopConfigurationProfile.find(id);
  // Operate on desktopConfigurationProfile
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Create Desktop Configuration Profile

SDK Method

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

import DesktopConfigurationProfile from 'files.com/lib/models/DesktopConfigurationProfile';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const desktopConfigurationProfile = await DesktopConfigurationProfile.create({
    name: "North America Desktop Profile",
    mount_mappings: {"key":"example value"},
  });
  // Operate on desktopConfigurationProfile
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Update Desktop Configuration Profile

SDK Method

desktopConfigurationProfile.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 DesktopConfigurationProfile from 'files.com/lib/models/DesktopConfigurationProfile';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  // Find the desktopConfigurationProfile object by its id.
  const desktopConfigurationProfile = await DesktopConfigurationProfile.find(id);
  await desktopConfigurationProfile.update({
    name: "North America Desktop Profile",
  });
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

Delete Desktop Configuration Profile

SDK Method

desktopConfigurationProfile.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 DesktopConfigurationProfile from 'files.com/lib/models/DesktopConfigurationProfile';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  // Find the desktopConfigurationProfile object by its id.
  const desktopConfigurationProfile = await DesktopConfigurationProfile.find(id);
  await desktopConfigurationProfile.delete();
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw 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.