Creating an API Client in Jamf Protect

Jamf Protect Documentation
Solution
Application
Content Type
Technical Documentation
Utilities & Services
ft:locale
en-US

Before you can interact with the Jamf Protect API, you must create an API client in Jamf Protect. Creating an API Client generates configuration and endpoint information, such as a client ID and API client password, which can be used for the following:

  • To obtain an access token

  • Register your Jamf Protect tenant with Jamf Pro.

Before creating an API client, consider the permissions necessary for that client. You can create a new role and assign the minimum required permissions for the API Integration, or you can assign the Read Only role to the client. The Read Only role will automatically include any future read-only permissions. The following permissions are the current recommended minimum permissions required for an API client.

  • Read only: Plans

  • Read only: API Clients

  • Read only: Downloads

These permissions are subject to change, and can be updated at any time. For more information about assigning custom roles, see User Roles and Groups.

Note:

You can have up to five API clients in Jamf Protect. To add an additional API client, you must delete one of the existing clients.

  1. In Jamf Protect, click Administrative > API Clients.
  2. Click Create API Client.
  3. Enter a name for your API client.
  4. Assign the minimum required permissions role to the API client.

    For example, Jamf Protect typically only requires Read access. Role assignments can be updated at any time.

  5. Copy the API client password for later use.
    Important:

    This value will not be displayed again by Jamf Protect.

Your API client configuration and endpoint information displays.

If you plan to use an API client to integrate with Jamf Pro or test with the Altair GraphQL Client application, make sure to copy the client ID in the API Client Configuration pane and the Jamf Protect API URL in the Token and API Endpoints pane.