Menu Bar App Preferences
This reference contains all available preferences for the Jamf Connect menu bar app.
Menu Bar Authentication Settings
- Domain—
com.jamf.connect
- Dictionary—
IdPSettings
- Description—
Used to allow Jamf Connect to complete authentication between your IdP and local accounts. Required settings vary by IdP.
Key | Description |
---|---|
| Identity Provider (Required) The name of your cloud identity Provider. The following values are supported:
|
| Okta Auth Server (Required: Okta Only) Your organization's Okta domain. A preceding "https://" is optional.
|
| Client ID (Required: OpenID Connect only) The client ID of your Jamf Connect app in your IdP. This value allows Jamf Connect to complete a resource owner password grant (ROPG), which is the process that performs password verification.
|
| Discovery URL Your IdP's OpenID Connect discovery endpoint. This value appears in the following format: https://domain.url.com/.well-known/openid-configuration If using AD FS, this value is your AD FS domain combined with the following: /adfs/.well- known/openid-configuration\ Note: This key is required if your Identity Provider (
|
| Tenant ID The Tenant ID for your organization used for authentication. Note: If IBM Security Verify is your IdP, this value is required and matches the tenant name used in your IBM URL. (e.g. https://companyname.ibmcloud.com)
|
| Change Password URL A URL to a password change web page supported by your IdP
|
| Reset Password URL A URL to a password reset web page supported by your IdP
|
| Client Secret The client secret of your Jamf Connect app in your IdP.
|
| Password Verification Success Codes An array of strings that contain error codes from your IdP during an ROPG password verification, which should be interpreted as successful by Jamf Connect. For possible error codes that may need to be configured in your environment, see the Azure AD Authentication and authorization error codes documentation from Microsoft. If using OneLogin, set this key to "MFA", if multifactor authentication is used in your environment.
|
Menu Bar Sign-in Settings
- Domain—
com.jamf.connect
- Dictionary—
SignIn
- Description—
Used to configure the sign-in user experience and multifactor authentication (MFA) options for Okta.
Key | Description |
---|---|
| Enable Automatic Sign-in Determines if Jamf Connect will automatically attempt to sign in the user if there are saved credentials in the user's keychain.
|
| Automatically Push Last MFA Method (Okta only) Determines whether the multifactor authentication (MFA) method from a user's last sign-in via Jamf Connect is automatically pushed during their next Jamf Connect sign-in attempt Note: Jamf Connect only detects MFA methods used within the menu bar app. MFA methods used during sign-ins to the Okta dashboard via a web browser or another application are not detected.
|
AutoOpenAppAtLogin | Automatically Open Jamf Connect at Login Set Jamf Connect as a login item for users. This setting is set to Note:
|
| Require Sign-in Determines if the Sign In window kept open on computers until users successfully authenticate.
|
| Sign-in Logo The file path to a locally stored image to use as a logo. Larger images will be automatically scaled down to an appropriate width whiling maintaining aspect ratio. Do not include a backslash "\" in your file path.
|
| Username Field Label Custom text for the Username field in the Sign In window
|
| Password Field Label Custom text for the Password field in the Sign In window
|
| Sign In Window Title Custom title for the Sign In window
|
| MFA Option Names (Okta only) Custom names for each MFA option used with Okta authentication in your organization. For more information about the types of MFA options you can configure with Jamf Connect and Okta, see Multifactor Authentication.
|
| Hidden MFA Options (Okta only) A list of MFA options that you do not want to display to users
|
| One-time Password Message (Okta only) Text displayed when a user must enter a one-time password (OTP) as a multifactor authentication (MFA) method
|
Menu Bar Custom Branding Settings
- Domain—
com.jamf.connect
- Dictionary—
Appearance
- Description—
Used to customize Jamf Connect for your organization
Key | Description |
---|---|
| Light Mode Icon The file path to a custom icon for the Jamf Connect menu bar icon when Light Mode is enabled A 16x16 pixel image is recommended.
|
| Dark Mode Icon The file path to a custom icon for the Jamf Connect menu bar icon that displays when Dark Mode is enabled on macOS 10.15 or earlier A 16x16 pixel image is recommended. Note: This setting is not supported on computers with macOS 11 or later. Use the Light Mode Icon (
|
AlternateBranding | Use Unbranded App Icon Use the alternate app icon for Jamf Connect rather than the default Jamf logo and company name. This setting is set to false by default.
|
| Show Welcome Window Display the Welcome window each time Jamf Connect is opened.
|
Unlock App Settings
- Domain
com.jamf.connect
- Dictonary
Unlock
- Description
- Used to configure Jamf Unlock app usage in the Jamf Connect menu bar app.
For more information about Jamf Unlock, see Jamf Unlock Overview.
Key | Description |
---|---|
| Enable Unlock Enables Jamf Unlock app usage and displays the Unlock menu items in the menu bar. This setting is set to
|
| Require PIN Requires Jamf Unlock users to use a PIN to complete authentication requests. Important: To ensure authentication with Jamf Unlock works as expected, make sure your PIN requirement settings are the same between your Jamf Unlock managed app configuration and Jamf Connect configuration profile.
|
EnableUnlockForLogin | Enable Unlock Authentication at the Login Window Allows users to use Jamf Unlock authentication to log in via Apple's native macOS login window. When enabled, users can switch between using a local password or Jamf Unlock by using Enable Jamf Unlock switch at the top of the login window. This setting is set to Note: The
|
User Help Settings
- Domain—
com.jamf.connect
- Dictionary—
UserHelp
- Description—
Used to configure in-app help options for users
Key | Description |
---|---|
| Get Help Type The type of help option used by Jamf Connect Note: Bomgar, URL and App are supported.
|
| Get Help Options A URL or file path that users can access by clicking Get Help in the Jamf Connect menu. Note: The
|
| Self Service Path The file path for a Self Service application that Jamf Connect does not automatically find. Jamf Connect will automatically detect Jamf Self Service and Munki Managed Software Center.
|
Password Policy Settings
- Domain—
com.jamf.connect
- Dictionary—
PasswordPolicies
- Description—
Used to configure network password checks, expiration notifications, and password policies
Key | Description |
---|---|
| Password Expiration Countdown Start Date An integer, in days remaining, before the password expiration countdown is displayed in the menu bar next to the app icon. By default, 14 days is used. This setting is disabled when set to 0. Note: To use this setting, Jamf Connect must be integrated with a Kerberos realm. For more information, see Kerberos Integration.
|
| Password Expiration Manual Override (Okta only) An integer, in days, that a user's Okta password is valid for in your organization. For example, if a user must change their Okta password every 90 days, set this value to 90. This allows Okta administrators to display the amount of days remaining before a user's password expires in the menu bar app for Okta accounts that are not mastered by Active Directory. To display this value next to the menu bar app icon in addition to in the menu bar, make sure to also configure the Password Expiration Countdown Start Date setting. Note: If your Okta accounts are mastered by Active Directory, this setting cannot be used. Continue to integrate Jamf Connect with a Kerberos realm and use the Password Expiration Countdown Start Date setting to display the password expiration date in the Jamf Connect menu bar app. |
| Password Expiration Notification Start Date An integer, in days remaining, before the user begins receiving notifications about an upcoming password expiration. By default, 7 days is used. This setting is disabled when set to 0.
|
| Network Check-in Frequency The check-in frequency that Jamf Connect will use to confirm the network password matches the local password. By default, 15 minutes is used. This setting is disabled when set to 0. Jamf Connect can only check the network password if the network is accessible.
|
| Perform Network Checks on Network Changes Determines whether Jamf Connect performs a network check when a computer's network status changes. This setting is set to true by default. If set to false , Jamf Connect only performs a network check during the the integer defined by the NetworkCheck key.
|
| Sync Passwords Message A message displayed to users when Jamf Connect detects that their local and network passwords are out of sync.
|
| Password Policy Requirements Defines the password complexity policy for changing the password. Jamf Connect will only enforce this setting if a different password policy from Active Directory or a cloud IdP is not detected.
|
| Password Policy Message A message that explains your configured password policy. This message only displays when a user tries to set a password that does not meet your password policy requirements.
|
Kerberos Settings
- Domain—
com.jamf.connect
- Dictionary—
Kerberos
- Description—
Used to integrate Jamf Connect with a Kerberos realm for password syncing
Key | Description |
---|---|
| Kerberos Realm Specifies the Kerberos realm used to get Kerberos tickets. Your Kerberos realm should be written in all caps.
|
| Renew Kerberos Tickets Determines if the Kerberos tickets should be renewed
|
| Cache Tickets On Network Change Determine whether a user's Kerberos tickets are cached or destroyed when a network status changes on computers. When set to
|
| Custom Short Name A custom short name to use to obtain Kerberos tickets.
|
| Short Name Attribute The ID token attribute to use as a short name. If unspecified, the Note:
|
| Ask for Short Name Determines if the user is asked to enter their Kerberos short name on first sign in
|
| Ask for Short Name Message The message displayed to users when requesting their Kerberos short name
|
Keychain Settings
- Domain—
com.jamf.connect
- Dictionary—
Keychain
- Description—
Used to allow Jamf Connect to sync passwords with keychain items
Key | Description |
---|---|
| Sync Password with Internet Keychain Items Internet accounts that Jamf Connect should sync with the local password.
|
| Update Keychain Items Keychain items that Jamf Connect should sync with the local password.
|
Okta Web Browser Settings
- Domain—
com.jamf.connect
- Dictionary—
WebBrowser
- Description—
Used to manage whether a user's Okta dashboard opens on sign-in and in what browser
Key | Description |
---|---|
| Launch Browser Determines whether the Okta dashboard is opened in a web browser when a user signs in with Jamf Connect.
|
| Browser Selection Determines which browser the Okta dashboard is opened in when a user signs in with Jamf Connect by enforcing a selection from the Browser pop-up menu at the Sign In window. Safari, Firefox, and Google Chrome are supported browsers.
|
Menu Item Customization Settings
- Domain—
com.jamf.connect
- Dictionary—
CustomMenuItems
- Description—
Used to customize the names of menu items in Jamf Connect
Key | Description |
---|---|
| About Menu Text Title of the About menu item
|
| Actions Menu Text Title of the Actions menu item
|
| Change Password Menu Text Title of the Change Password menu item
|
| Get Help Menu Text Title of the Get Help menu item
|
| Get Software Menu Text Title of the Get Software menu item
|
| Home Directory Menu Text Title of the Home directory menu item
|
| Kerberos Ticket Menu Text Title of the Kerberos Tickets menu item
|
| Preferences Menu Text Title of the Preferences menu item
|
| Reset Password Menu Text Title of the reset password menu item
|
| Shares Menu Text Title of the shares menu item
|
| Connect Menu Text Title of the Connect menu item
|
Menu Item Display Settings
- Domain—
com.jamf.connect
- Key—
HiddenMenuItems
- Description—
An array of strings used to hide Jamf Connect menu items from users
Value | Description |
---|---|
| Hide About Menu Item Hides the About window
|
| Hide Actions Menu Item Hides the custom configured Actions menu item
|
| Hide Change Passwords Menu Item Hides the Change Password menu item
|
| Hide Get Help Menu Item Hides the Get Help menu
|
| Hide Get Software Menu Item Hides the Get Software menu Note: If a self-service app is not installed on computers, this menu item is hidden by default.
|
| Hide Home Directory Menu Item Hides the home directory menu item Note: If a home share is not detected, this menu item is hidden by default
|
tickets | Hide Kerberos Ticket Menu Item Hides the Tickets menu item Note: If a Kerberos realm is not configured, this menu item is hidden by default.
|
lastuser | Hide Last User Menu Item Hides the last user menu item
|
| Hide Password Expiration Menu Item Hides the Password Expiration menu item
|
| Hide Preferences Menu Item Hides the Preferences menu item
|
| Hide Reset Password Menu Item Hides the reset password menu item
|
| Hide Shares Menu Item Hide the Share menu item
|
| Hide Connect Menu Item Hides the Connect menu item
|
| Hide Quit Menu Item Hides the Quit menu item
|
Menu Bar Script Settings
- Domain—
com.jamf.connect
- Dictionary—
Scripting
- Description—
Used to run custom scripts that are triggered by Jamf Connect authentication events
Key | Description |
---|---|
| Password Change Script The file path to a script or other binary to run after successful password change
|
| Successful Sign-in Script The file path to a script or other binary to run after a successful Jamf Connect authentication
|
| Failed Sign-in Script The file path to a script or other binary to run after an unsuccessful Jamf Connect authentication attempt
|
| Network Change Script The file path to a script or other binary to execute after a network change is detected
|
Certificate Settings
- Domain—
com.jamf.connect
- Dictionary—
Certificates
- Description—
Used to configure Windows web CA settings
Key | Description |
---|---|
| X.509 Certificate Authority Specifies the URL of the Windows web certificate authority (CA) for Jamf Connect to use for certificates
|
| Certificate Template Certificate template from a Windows web CA
|
| Get Certificates Automatically Enables Jamf Connect to get a certificate from a Windows web CA automatically on sign-in
|
| Associated Wi-Fi Networks A list of secure wireless networks to associate with the certificate Jamf Connect created
|
| Allow Private Key Exports Allow the private key of the user certificate to be exported
|
File Share Settings
- Domain—
com.jamf.connect.shares
- Description—
Used to configure the file share menu item in Jamf Connect.
Important:Microsoft Distributed File System (DFS) shares are currently not supported by Jamf Connect's file share feature.
Key | Description |
---|---|
| Determines if a user's home profile should be mounted. This is written as a dictionary of keys including the
|
| Specifies which active directory group members should have their home profile mounted |
| An array of mount options Note: See the Options table for available options. |
| Determines a mount point and its associated attributes. This is written as an array of dictionaries.
|
| If set to true, the share is automatically mounted |
| If set to true, the share is only mounted when the computer is connected to the active directory domain. |
| Specifies which active directory group members should have their home profile mounted. |
| Specifies a local mount point |
| Specifies the name of the share displayed as a menu item in Jamf Connect |
| An array of mount options Note: See the Options table for available options. |
| Specifies the URL of the mount point. You can use variable substitution to create custom mount points. Jamf Connect can substitute any of the following variables with the corresponding value from the user's AD account:
|
Action Item Settings
- Domain—com.jamf.connect.actions
- Description—
Used to create and configure custom menu items to display in the menu bar app. For more information, see Custom Menu Bar Action Items.
Global Action Settings
Key | Description | Type |
---|---|---|
| Determines if the action menu will display a status icon (green, yellow, or red) Note: | Boolean |
| When set to true, Jamf Connect will use the result of the command as the text of the menu item. Note: | Boolean |
Action Component Settings
Key | Description | Type |
---|---|---|
| (Required) The name of the action | String |
| The text used to display the item in the menu bar Note: If unspecified, the | Dictionary |
| Determines if the item is displayed in the menu or not Note: All commands in the | Array |
| Contains the action
| Array |
| Determines what happens after the action is run. | Array |
| The unique ID for the action | String |
| Determines if the action set should only be run when connected to an Active Directory domain | Boolean |
| Length in minutes between executing the action | Integer |
| The text displayed when hovering over a menu item | String |
| Creates a visual separator bar in the menu bar |
|