Support Companion

If configured, a menu item "Knowledge base" will show up where the user can browse the page from the UI.

Configures whether to show the Identity menu item. Defaults to true

Default: true

Configures whether to show the Apps menu item. Defaults to true

Default: true

Configures whether to show the Self Service menu item. Defaults to true

Default: true

Configures whether to show the Company Portal menu item. Defaults to true

Default: true

Configures whether to show the Knowledge Base menu item. Defaults to true

Default: true

Configures the name shown in the navigation menu.

Configures the brand color shown in the app, specify in hex format.

Configures the brand logo shown in the apps side menu. Specify a Base64 string.

Configures the brand logo shown in the apps side menu when light theme is used. Specify a base64 string

Configures the URL to open when the user clicks on the Get Support button.

Configures the URL to open when the user clicks on the Change Password button.

Configures the mode for the Change Password button, available modes are: local, SSOExtension, url. Defaults to local if not configured.

Range: Local (local), SSO Extension (SSOExtension), URL (url)

Configures the email address shown when the user clicks on the Support Info button.

Configures the phone number shown when the user clicks on the Support Info button.

Configures which cards to hide, available cards are: DeviceInformation, Evergreen, Battery, Actions, ApplicationInstallProgress, Storage, DeviceManagement, PendingAppUpdates.

Configures which actions to hide, available actions are: ChangePassword, Reboot, OpenManagementApp, GetSupport, GatherLogs, SoftwareUpdates, RestartIntuneAgent.

Configures the interval for notifications in hours for Application Updates and Software Updates notifications.

Range: 1 – 24

Configures the title for notifications for notifications. Defaults to Support Companion if not configured.

Configures an image to add to notifications. Local path should be specified.

Configures the message for notifications for Software Updates notifications. Defaults to "Software Updates Available. Please update your device to the latest version." if not configured.

Default: "Software Updates Available. Please update your device to the latest version."

Configures the button text for notifications for Software Updates notifications. Defaults to "Update Now 🚀" if not configured.

Default: "Update Now 🚀"

Configures the message for notifications for App Updates notifications. Defaults to "App Updates Available. Please update your apps to the latest version." if not configured.

Default: "App Updates Available. Please update your apps to the latest version."

Configures the button text for notifications for App Updates notifications. Defaults to "Update Now 🚀" if not configured.

Default: "Update Now 🚀"

Configures the app to show application info for either Munki, Intune or to use System profiler for app info. The app tries to dynamically detect which mode to use.

Range: Munki, Intune, SystemProfiler

Configures the log folders to gather logs from. Only used when gathering logs. Defaults to "/Library/Logs/Microsoft" if not configured.

Configures custom actions to add to the tray menu. See example below.

Configures the desktop info widget.

Default: false

Configures the position of the desktop info. Defaults to Lower Right.

Default: "LowerRight"

Range: Upper Left (UpperLeft), Upper Right (UpperRight), Lower Left (LowerLeft), Lower Right (LowerRight)

Configures the level of information to show on the desktop. Defaults to 4.

Range: 1, 2, 3, 4, 5

Use this array to determine which information to hide. Available items are: HostName, Model, SerialNumber, Processor, IPAddress, Memory, OSBuild, OSVersion, LastRestart, FileVault, StorageName, SupportPhone, SupportEmail. It is also possible to hide entire sections: Hardware Specifications, System Information, Network Information, Storage, Support.

Configures the opacity of the desktop info. Defaults to 0%.

Default: 1

Range: 10% (0.1), 20% (0.2), 30% (0.3), 40% (0.4), 50% (0.5), 60% (0.6), 70% (0.7), 80% (0.8), 90% (0.9), 100% (1)

Enables a frosted glass look on the desktop info when set to true.

Configures the font size for the desktop info. Defaults to 14.

Default: 14

Range: 8 – 24

Configures a path to a JSON file containing custom widgets to show on the Home view.

When set to true allows the user to elevate to admin during a set time frame. Defaults to false.

Default: false

Requires the user to enter a reason for the elevation. Defaults to false.

Default: false

Set a minimum amount of characters the user must enter as the reason. Defaults to 10.

Default: 10

The amount of time (in minutes) the user is elevated. Defaults to 5.

Default: 5

When configured, sends the entered elevation reason to a webhook instead of saving to disk.

Configure wether to show the elevate button in the tray menu or not. Defaults to false.

Default: false

Configure the elevation severity. Defaults to 6 (Informational).

Default: 6

Configure a path to a Markdown file to show in the menu.

Configure the menu label for the custom Markdown view.

Configure the icon for the custom Markdown menu item.

Configure the menu label for the custom cards view.

Configure the icon for the custom cards menu item.

Disables the requirement for the user to enter their credentials when running privileged actions via the CLI.

Default: true

Name of the action to show in the menu.

Command to run when to item is clicked.

SF Symbol to show in the Self Service page in the UI.

SF Symbol to show in the Self Service page in the UI.

Description to show in the Self Service page in the UI.

Configures the button label for the action.

Range: Host Name (HostName), Model (Model), Serial Number (SerialNumber), Processor (Processor), IP Address (IPAddress), Memory (Memory), OS Build (OSBuild), OS Version (OSVersion), Last Restart (LastRestart), FileVault (FileVault), Storage Name (StorageName), Support Phone (SupportPhone), Support Email (SupportEmail), Hardware Specifications (Hardware Specifications), System Information (System Information), Network Information (Network Information), Storage (Storage), Support (Support), Category (Category), Divider (Divider)