Desktop Configuration Profiles
A Desktop Configuration Profile centrally defines desktop mount point mappings for users in a Site or Workspace.
List Desktop Configuration Profiles
Command
files-cli desktop-configuration-profiles list
Output
Outputs a list of DesktopConfigurationProfile objects according to the output format.
Authorization Requirement
Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.
Additional Arguments
Show Desktop Configuration Profile
Command
files-cli desktop-configuration-profiles find
Output
Outputs a DesktopConfigurationProfile object according to the output format.
Authorization Requirement
Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.
Flags
| Flag | Description |
|---|---|
| --id= int64 Required | Desktop Configuration Profile ID. |
Create Desktop Configuration Profile
Command
files-cli desktop-configuration-profiles create
Output
Outputs a DesktopConfigurationProfile object according to the output format.
Authorization Requirement
Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.
Flags
| Flag | Default | Description |
|---|---|---|
| --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 | 0 | Workspace ID |
| --use-for-all-users boolean | false | Whether this profile applies to all users in the Workspace by default |
| --disable-drive-mounting boolean | false | Whether the desktop app should hide drive mounting, prevent new drive mounts, and unmount active drive mounts for users with this profile |
Update Desktop Configuration Profile
Command
files-cli desktop-configuration-profiles update
Output
Outputs a DesktopConfigurationProfile object according to the output format.
Authorization Requirement
Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.
Flags
| Flag | Description |
|---|---|
| --id= int64 Required | Desktop Configuration Profile ID. |
| --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 |
Delete Desktop Configuration Profile
Command
files-cli desktop-configuration-profiles delete
Output
No output is returned.
Authorization Requirement
Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.
Flags
| Flag | Description |
|---|---|
| --id= int64 Required | Desktop Configuration Profile ID. |
The DesktopConfigurationProfile Object
Some of the commands above return a DesktopConfigurationProfile object. The attributes of this object are listed below.
| Attribute | Description |
|---|---|
| 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. |