Jamf Self Service for macOS URL Schemes

Jamf Pro Documentation 11.16.0

Solution
Application
Content Type
Technical Documentation
Utilities & Services
version
11.16.0
ft:locale
en-US
vrm_version
11.16.0

URL schemes provide a way to directly reference resources within Jamf Self Service for macOS. You can configure URL schemes to do the following actions in Self Service:

  • Install an item made available in Self Service

  • Direct users to the description of an item made available in Self Service

  • Direct users to specific Self Service categories

  • Direct users to the History or Notifications tabs

  • Direct users to the Compliance Remediation page

Once configured, you can provide the URL schemes to your users (e.g., via email or a webpage). Clicking the URL scheme on a computer prompts Self Service to open.

You can create as many URL schemes as needed using the templates in the table below:

URL Scheme Type

Description

URL Template

Install item

Install an item by replacing "<content_type>" with the type of item (policy, app, configprofile, or ebook) and replace "<content_id>" with the item ID found in the item URL in Jamf Pro. Users may need to log in to Self Service in order to complete the installation. This is not available for patch policies.

Note:

The URL for an item is also available on the Self Service tab of that item. You can copy the item URL from Jamf Pro by clicking the Clipboard button.

jamfselfservice://content?entity=<content_type>&id=<content_id>&action=execute

Examples:
  • Install configuration profile #40: jamfselfservice://content?entity=configprofile&id=40&action=execute

  • Run policy #22: jamfselfservice://content?entity=policy&id=22&action=execute

  • Install eBook #17: jamfselfservice://content?entity=ebook&id=17&action=execute

  • Install app #59: jamfselfservice://content?entity=app&id=59&action=execute

Open item description

Direct users to the description of an item by replacing "<content_type>" with the type of item (policy, app, configprofile, or ebook) and replace "<content_id>" with the item ID found in the item URL in Jamf Pro. This is not available for patch policies.

Note:

The URL for an item description is also available on the Self Service tab of that item. You can copy the item URL from Jamf Pro by clicking the Clipboard button.

jamfselfservice://content?entity=<content_type>&id=<content_id>&action=view

Examples:
  • Open configuration profile #40 description: jamfselfservice://content?entity=configprofile&id=40&action=view

  • Open policy #22 description: jamfselfservice://content?entity=policy&id=22&action=view

  • Open eBook #17 description: jamfselfservice://content?entity=ebook&id=17&action=view

  • Open app #59 description: jamfselfservice://content?entity=app&id=59&action=view

Open category

Direct users to a specific category in Self Service by replacing "<category_ID>" with the category ID found in the category URL in Jamf Pro or use one of the following IDs for the default categories:

  • -1 for the All category
  • -2 for the Featured category
  • -3 for the Bookmarks category
  • -4 for the Compliance category
Note:

The macOS Intune Integration must be enabled for the Compliance category to be made available in Self Service.

jamfselfservice://content?action=category&id=<category_id>

Example: jamfselfservice://content?action=category&id=-1

Open History tab

Direct users to the History tab

jamfselfservice://content?action=history

Open Notifications tab

Direct users to the Notifications tab

jamfselfservice://content?action=notifications

Open Compliance Remediation page

Direct users to the Compliance Remediation page

Note:

The macOS Intune Integration must be enabled for the Compliance Remediation page to be made available in Self Service.

jamfselfservice://remediate

Open to search term

Direct users to specific search results by replacing "searchterm" with the search term

jamfselfservice://content?action=search&term=searchterm