Support Companion

com.github.macadmins.SupportCompanion

Support Companion settings

macOS

macOS 14.0+

Configuration Keys (80)

Showing 80 of 80 keys

Key	Type	Description	Default	Range
`PFC_SegmentedControl_0`string required	string	—	Default: —	Range: —
`KnowledgeBaseUrl`string Knowledge Base Url	string	If configured, a menu item "Knowledge base" will show up where the user can browse the page from the UI.	Default: —	Range: —
`MenuShowIdentity`boolean Show Identity Menu Item	boolean	Configures whether to show the Identity menu item. Defaults to true	Default: true	Range: —
`MenuShowApps`boolean Show Apps Menu Item	boolean	Configures whether to show the Apps menu item. Defaults to true	Default: true	Range: —
`MenuShowSelfService`boolean Show Self Service Menu Item	boolean	Configures whether to show the Self Service menu item. Defaults to true	Default: true	Range: —
`MenuShowCompanyPortal`boolean Show Company Portal Menu Item	boolean	Configures whether to show the Company Portal menu item. Defaults to true	Default: true	Range: —
`MenuShowKnowledgeBase`boolean Show Knowledge Base Menu Item	boolean	Configures whether to show the Knowledge Base menu item. Defaults to true	Default: true	Range: —
`BrandName`string Brand Name	string	Configures the name shown in the navigation menu.	Default: —	Range: —
`AccentColor`string Accent Color	string	Configures the brand color shown in the app, specify in hex format.	Default: —	Range: —
`BrandLogo`string Brand Logo	string	Configures the brand logo shown in the apps side menu. Specify a Base64 string.	Default: —	Range: —
`BrandLogoLight`string Brand Logo Light	string	Configures the brand logo shown in the apps side menu when light theme is used. Specify a base64 string	Default: —	Range: —
`SupportPageUrl`string Support Page URL	string	Configures the URL to open when the user clicks on the Get Support button.	Default: —	Range: —
`ChangePasswordUrl`string Change Password URL	string	Configures the URL to open when the user clicks on the Change Password button.	Default: —	Range: —
`ChangePasswordMode`string Change Password Mode	string	Configures the mode for the Change Password button, available modes are: local, SSOExtension, url. Defaults to local if not configured.	Default: —	Range: Local (local), SSO Extension (SSOExtension), URL (url)
`SupportEmail`string Support Email	string	Configures the email address shown when the user clicks on the Support Info button.	Default: —	Range: —
`SupportPhone`string Support Phone	string	Configures the phone number shown when the user clicks on the Support Info button.	Default: —	Range: —
`HiddenCards`array Hidden Cards	array	Configures which cards to hide, available cards are: DeviceInformation, Evergreen, Battery, Actions, ApplicationInstallProgress, Storage, DeviceManagement, PendingAppUpdates, Jamf, Fleet, FleetPolicies.	Default: —	Range: —
string	string	—	Default: —	Range: Device Information (DeviceInformation), Evergreen (Evergreen), Battery (Battery), Actions (Actions), Application Install Progress (ApplicationInstallProgress), Storage (Storage), Device Management (DeviceManagement), Pending App Updates (PendingAppUpdates), Jamf (Jamf), Fleet (Fleet), Fleet Policies (FleetPolicies)
`HiddenActions`array Hidden Actions	array	Configures which actions to hide, available actions are: ChangePassword, Reboot, OpenManagementApp, GetSupport, GatherLogs, SoftwareUpdates, RestartIntuneAgent.	Default: —	Range: —
string	string	—	Default: —	Range: Change Password (ChangePassword), Reboot (Reboot), Open Management App (OpenManagementApp), Get Support (GetSupport), Gather Logs (GatherLogs), Software Updates (SoftwareUpdates), Restart Intune Agent (RestartIntuneAgent)
`NotificationInterval`integer Notification Interval	integer	Configures the interval for notifications in hours for Application Updates and Software Updates notifications.	Default: —	Range: 1 – 24
`NotificationTitle`string Notification Title	string	Configures the title for notifications for notifications. Defaults to Support Companion if not configured.	Default: —	Range: —
`NotificationImage`string Notification Image	string	Configures an image to add to notifications. Local path should be specified.	Default: —	Range: —
`SoftwareUpdateNotificationMessage`string Software Update Notification Message	string	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."	Range: —
`SoftwareUpdateNotificationButtonText`string Software Update Notification Button Text	string	Configures the button text for notifications for Software Updates notifications. Defaults to "Update Now 🚀" if not configured.	Default: "Update Now 🚀"	Range: —
`AppUpdateNotificationMessage`string App Update Notification Message	string	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."	Range: —
`AppUpdateNotificationButtonText`string App Update Notification Button Text	string	Configures the button text for notifications for App Updates notifications. Defaults to "Update Now 🚀" if not configured.	Default: "Update Now 🚀"	Range: —
`RebootReminderDays`integer Reboot Reminder Days	integer	Configures the number of days after which the user will be reminded to reboot. Defaults to 0 days if not configured (no reminder).	Default: 0	Range: —
`Mode`string Mode	string	Configures which source the app reads application information from. Detection runs only when this is empty: Fleet is chosen on Macs running Fleet's agent (orbit) when no other mode matches.	Default: —	Range: Munki, Intune, Jamf, Fleet, SystemProfiler
`RefreshSelfService`boolean Refresh Self Service	boolean	Configures whether to refresh the Self Service+ app data in the background when in Jamf mode. Defaults to true	Default: true	Range: —
`JamfLogPollHours`integer Jamf Log Poll Hours	integer	Configures how often to poll Jamf logs in hours. Only used when in Jamf mode. Defaults to 36 if not configured.	Default: 36	Range: 0 – —
`LogFolders`array Log Folders	array	Configures the log folders to gather logs from. Only used when gathering logs. Defaults to "/Library/Logs/Microsoft" if not configured.	Default: —	Range: —
string	string	—	Default: —	Range: —
`ExcludedLogFolders`array Excluded Log Folders	array	Configures the log folders to exclude when gathering logs. Only used when gathering logs.	Default: —	Range: —
string	string	—	Default: —	Range: —
`Actions`array Actions	array	Configures custom actions to add to the tray menu. Actions defined in the user's own preferences still run, but IsPrivileged is honored only when the action comes from a configuration profile. From 3.0 the app sends only the action's name and the helper looks the command up itself, so a privileged action must be defined in a profile to run at all.	Default: —	Range: —
dict	dict	—	Default: —	Range: —
`Name`string Name	string	Name of the action to show in the menu.	Default: —	Range: —
`Command`string Command	string	Command to run when to item is clicked.	Default: —	Range: —
`Icon`string Icon	string	SF Symbol to show in the Self Service page in the UI.	Default: —	Range: —
`IsPrivileged`boolean Is Privileged	boolean	SF Symbol to show in the Self Service page in the UI.	Default: —	Range: —
`Description`string Description	string	Description to show in the Self Service page in the UI.	Default: —	Range: —
`ButtonLabel`string Button Label	string	Configures the button label for the action.	Default: —	Range: —
`ShowLogoInTrayMenu`boolean Show Logo In Tray Menu	boolean	Configures whether to show the branding logo in the tray menu. Defaults to true.	Default: true	Range: —
`TrayMenuBrandingIcon`string Tray Menu Branding Icon	string	Configures the icon to show in the tray menu. Specify a Base64 string.	Default: —	Range: —
`TrayMenuShowIcon`boolean Show Tray Menu Icon	boolean	Configures whether to show the tray menu icon. Useful if you only want to show desktop information for example. Defaults to true.	Default: true	Range: —
`ShowDesktopInfo`boolean Show Desktop Info	boolean	Configures the desktop info widget.	Default: false	Range: —
`DesktopInfoWindowPosition`string Desktop Position	string	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)
`DesktopInfoLevel`integer Desktop Info Level	integer	Configures the level of information to show on the desktop. Defaults to 4.	Default: —	Range: 1, 2, 3, 4, 5
`DesktopInfoHideItems`array Desktop Info Hide Items	array	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.	Default: —	Range: —
string	string	—	Default: —	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)
`DesktopInfoBackgroundOpacity`real Desktop Info Background Opacity	real	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)
`DesktopInfoBackgroundFrosted`boolean Desktop Info Background Frosted	boolean	Enables a frosted glass look on the desktop info when set to true.	Default: —	Range: —
`DesktopInfoFontSize`integer Desktop Info Font Size	integer	Configures the font size for the desktop info. Defaults to 14.	Default: 14	Range: 8 – 24
`CustomCardPath`string Custom Card Path	string	Configures a path to a JSON file containing custom widgets to show on the Home view.	Default: —	Range: —
`DebugLogging`boolean Debug Logging	boolean	Configures whether debug logging is enabled. Defaults to false.	Default: false	Range: —
`EnableElevation`boolean Enable Elevation	boolean	When set to true allows the user to elevate to admin during a set time frame. Defaults to false. From 3.0 this is only honored when it comes from a configuration profile.	Default: false	Range: —
`RequireResonForElevation`boolean Require Reason For Elevation	boolean	Requires the user to enter a reason for the elevation. Defaults to false. From 3.0 this is only honored when it comes from a configuration profile.	Default: false	Range: —
`ReasonMinLength`integer Reason Min Length	integer	Set a minimum amount of characters the user must enter as the reason. Defaults to 10. From 3.0 this is only honored when it comes from a configuration profile.	Default: 10	Range: —
`MaxElevationTime`integer Max Elevation Time	integer	The amount of time (in minutes) the user is elevated. Defaults to 5. From 3.0 this is only honored when it comes from a configuration profile.	Default: 5	Range: —
`ElevationWebhookUrl`string Elevation Webhook Url	string	When configured, sends the entered elevation reason to a webhook instead of saving to disk. From 3.0 this is only honored when it comes from a configuration profile.	Default: —	Range: —
`ShowElevateTrayCard`boolean Show Elevate Tray Card	boolean	Configure wether to show the elevate button in the tray menu or not. Defaults to false.	Default: false	Range: —
`ElevationSeverity`integer Elevation Severity	integer	Configure the elevation severity. Defaults to 6 (Informational). From 3.0 this is only honored when it comes from a configuration profile.	Default: 6	Range: —
`MarkdownFilePath`string Markdown File Path	string	Configure a path to a Markdown file to show in the menu.	Default: —	Range: —
`MarkdownMenuLabel`string Markdown Menu Label	string	Configure the menu label for the custom Markdown view.	Default: —	Range: —
`MarkdownMenuIcon`string Markdown Menu Icon	string	Configure the icon for the custom Markdown menu item.	Default: —	Range: —
`CustomCardsMenuLabel`string Custom Cards Menu Label	string	Configure the menu label for the custom cards view.	Default: —	Range: —
`CustomCardsMenuIcon`string Custom Cards Menu Icon	string	Configure the icon for the custom cards menu item.	Default: —	Range: —
`RequirePrivilegedActionAuthentication`boolean Require Privileged Action Authentication	boolean	Requires the user to authenticate before a privileged action runs. From 3.0 this defaults to true unless an administrator sets it, and is honored only from a configuration profile.	Default: true	Range: —
`EnforceAdminAllowlist`boolean Enforce Admin Allowlist	boolean	When true, the helper reconciles the admin group at startup and every five minutes: any account holding administrator rights that is neither listed in PermanentAdmins nor inside a live elevation window is demoted. Set PermanentAdmins before enabling this, or those accounts are demoted within five minutes. Defaults to false. Must be delivered in a device-scoped configuration profile; it is ignored anywhere else.	Default: false	Range: —
`PermanentAdmins`array Permanent Admins	array	Accounts that may hold administrator rights permanently when EnforceAdminAllowlist is enabled. List every such account: management accounts, break-glass accounts, permanently administrative staff, and anything granted rights by another system such as Platform SSO's AdministratorGroups. An explicitly empty array is honored and means no account is a permanent administrator; a missing list is refused with an error rather than acted on. root is always permitted. Must be delivered in a device-scoped configuration profile; it is ignored anywhere else.	Default: —	Range: —
string	string	—	Default: —	Range: —
`ElevationAllowedAdmins`array Elevation Allowed Admins	array	Accounts the elevation watchdog ignores, for management accounts an MDM may legitimately add while somebody is elevated. Defaults to an empty list. Must be delivered in a device-scoped configuration profile; it is ignored anywhere else.	Default: []	Range: —
string	string	—	Default: —	Range: —
`EnableUserInstalls`boolean Enable User Installs	boolean	When true, a standard user can install a .pkg or .dmg listed in AllowedInstallers without holding administrator rights. Both the app and the helper read this: the app decides whether to stage a file at all, the helper decides whether to install it. Defaults to false. Read only from a configuration profile, device-scoped or scoped to the user being served.	Default: false	Range: —
`ShowInstallerServiceMenuItem`boolean Show Installer Service Menu Item	boolean	Whether Finder's context menu offers "Install with Support Companion". Follows EnableUserInstalls unless set explicitly; set it to false to keep user installs but route everyone through the in-app catalog. Applied on every launch.	Default: —	Range: —
`RequireAuthenticationForInstalls`boolean Require Authentication For Installs	boolean	Whether the user authenticates before a user install proceeds. They authenticate as themselves, not as an administrator. Turning this off means an unlocked unattended Mac is enough to install an allowlisted item. Defaults to true.	Default: true	Range: —
`UserInstallFallback`string User Install Fallback	string	What to offer when an installer is not on the allowlist. "installer" opens it in Apple's Installer, "elevate" offers the normal time-limited elevation instead, "none" offers nothing. Defaults to "installer".	Default: "installer"	Range: Open in Installer (installer), Offer Elevation (elevate), None (none)
`SkipHelperInstall`boolean Skip Helper Install	boolean	When true, the package does not install or load its own copy of the privileged helper, and removes any it finds. Set this only where the helper is deployed declaratively with com.apple.configuration.services.background-tasks, otherwise two daemons claim the same Mach service. Defaults to false. Must be delivered in a device-scoped configuration profile; it is ignored anywhere else.	Default: false	Range: —
`FleetUrl`string Fleet URL	string	Overrides the Fleet server URL otherwise discovered from fleetd or orbit. Read only from a configuration profile, because the device's token is sent to whatever server this names.	Default: —	Range: —
`FleetRecommendedApps`array Fleet Recommended Apps	array	Fleet software keys pinned to the top of the self-service catalog, whether or not they are already installed.	Default: —	Range: —
string	string	—	Default: —	Range: —
`FleetRecommendedTitle`string Fleet Recommended Title	string	Renames the recommended section of the Fleet catalog.	Default: —	Range: —
`FleetIconsFromGitHub`boolean Fleet Icons From GitHub	boolean	Whether to fetch application icons from Fleet's public catalog on GitHub. Defaults to true.	Default: true	Range: —
`FleetAppOpenMessages`array Fleet App Open Messages	array	Replaces the built-in wording shown when an install is waiting for the user to quit the application first.	Default: —	Range: —
string	string	—	Default: —	Range: —
`FleetButtonLabels`dict Fleet Button Labels	dict	Custom button text in the Fleet catalog, keyed by software title and optionally nested by action.	Default: —	Range: —
`Title`string	string	Software title, or an action name nested under one.	Default: —	Range: —
`FleetNotifyUpdates`boolean Fleet Notify Updates	boolean	Notify when Fleet reports available application updates. Defaults to true.	Default: true	Range: —
`FleetNotifyInstallResults`boolean Fleet Notify Install Results	boolean	Notify when a Fleet install, update or uninstall finishes. Defaults to true.	Default: true	Range: —
`FleetNotifyPolicies`boolean Fleet Notify Policies	boolean	Notify when Fleet policies are failing on the Mac. Defaults to true.	Default: true	Range: —
`FleetNotifySignIn`boolean Fleet Notify Sign In	boolean	Remind the user to sign in to Fleet Desktop SSO while signed out, at most once a day. Defaults to false, unlike the other Fleet notifications.	Default: false	Range: —
`CompanyPortalUrl`string Company Portal URL	string	Overrides the Company Portal URL, for sovereign cloud endpoints such as GCC High.	Default: —	Range: —
`SoftwareUpdateNotificationCommand`string Software Update Notification Command	string	Command run when the software update notification's button is clicked. Defaults to opening the Software Update pane.	Default: —	Range: —
`AppUpdateNotificationCommand`string App Update Notification Command	string	Command run when the application update notification's button is clicked. Set at every launch to open the management application for the detected mode; a value forced by profile still wins.	Default: —	Range: —
`FileDebugLogging`boolean File Debug Logging	boolean	Write debug logging to disk as well as to the unified log. Defaults to false.	Default: false	Range: —
`AllowedInstallers`array Allowed Installers	array	Installers a standard user may install without administrator rights when EnableUserInstalls is true. The helper re-reads this and re-derives the installer's facts before it acts, so the confirmation sheet the user sees is presentation only. Entries that cannot decide anything are dropped and logged. Read only from a configuration profile, device-scoped or scoped to the user being served.	Default: —	Range: —
`Installer`dict	dict	—	Default: —	Range: —
`Name`string Name	string	Display name for this entry. Required.	Default: —	Range: —
`SHA256`string SHA256	string	64 hex characters. When present the entry is strict: it pins one exact build and stops matching as soon as the vendor ships an update.	Default: —	Range: —
`TeamID`string Team ID	string	The signing team. Required whenever SHA256 is absent.	Default: —	Range: —
`LeafCertificateSHA256`string Leaf Certificate SHA256	string	Pins the signing certificate itself. Stricter than TeamID, and needs updating when the vendor renews.	Default: —	Range: —
`PackageIdentifier`array Package Identifier	array	Package identifiers this entry allows, for a .pkg. A distribution package needs every component listed. A single string is also accepted.	Default: —	Range: —
string	string	—	Default: —	Range: —
`BundleIdentifier`array Bundle Identifier	array	Bundle identifiers this entry allows, for the application inside a .dmg. A single string is also accepted.	Default: —	Range: —
string	string	—	Default: —	Range: —
`AllowAnyIdentifier`boolean Allow Any Identifier	boolean	Accept anything the named team signs. This is a vendor allowlist rather than an application allowlist. Defaults to false.	Default: false	Range: —
`MinimumVersion`string Minimum Version	string	Refuse builds older than this, so a signed but vulnerable version cannot be installed instead.	Default: —	Range: —
`RequireNotarized`boolean Require Notarized	boolean	Require the installer to be notarized. Defaults to true.	Default: true	Range: —
`AllowScripts`boolean Allow Scripts	boolean	Whether the package may carry install scripts. A scriptless package landing in /Applications is a file copy; one with a postinstall is arbitrary root code on every future build the vendor signs. Defaults to false.	Default: false	Range: —
`AllowedPayloadPrefixes`array Allowed Payload Prefixes	array	Absolute path prefixes this installer may write to. Unrestricted when unset, though some destinations always need naming explicitly.	Default: —	Range: —
string	string	—	Default: —	Range: —
`AllowUnrestrictedPayload`boolean Allow Unrestricted Payload	boolean	Lets this installer write anywhere, including the destinations that otherwise always need naming. Its own key, so the most dangerous setting has to be meant. Defaults to false.	Default: false	Range: —