v4

latestSwagger 2.02026-08-0343714211.7 MB

desktop_configuration_profiles

Desktop Configuration Profiles

List Desktop Configuration Profiles

get/desktop_configuration_profiles

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are workspace_id and name.

If set, return records where the specified field is equal to the supplied value. Valid fields are workspace_id.

Response

A list of DesktopConfigurationProfiles objects.

idinteger

Desktop Configuration Profile ID

namestring

Profile name

workspace_idinteger

Workspace ID

use_for_all_usersboolean

Whether this profile applies to all users in the Workspace by default

disable_drive_mountingboolean

Whether the desktop app should hide drive mounting, prevent new drive mounts, and unmount active drive mounts for users with this profile

mount_mappingsobject

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.

Example response

[
  {
    "id": 1,
    "name": "North America Desktop Profile",
    "workspace_id": 1,
    "mount_mappings": {
      "key": "example value"
    }
  }
]