Creating an API Role

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

To grant privileges to an API client in Jamf Pro, you must first create an API role that defines a privilege set. One or more of these roles can then be assigned to a client to grant their cumulative privileges.

  1. In Jamf Pro, click Settings in the sidebar.
  2. In the System section, click API Roles and Clients .
  3. Click the API Roles tab at the top of the pane.
  4. Click New .
  5. Enter a display name for the API role.
  6. In the Jamf Pro API role privileges field, begin typing the name of a privilege you want to assign, and then select it from the pop-up menu.

    Continue adding privileges this way until you are finished.

  7. Click Save .
Note:

If you are using Jamf Setup, Jamf Reset, Jamf Parent, or Jamf Teacher in your environment, you may notice there are API roles already created and in use by these applications. These roles can be reused safely with other API clients that require similar privileges, but Jamf does not recommend editing these roles, as it could interfere with the functionality of those apps. Jamf Pro will not allow any API roles to be deleted while in use.