Creating an API Client

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

You can create an API client in Jamf Pro to generate a client secret, which can then be used by the Jamf Pro API to generate access tokens.

Requirements

At least one API role created in Jamf Pro

  1. In Jamf Pro, click Settings in the sidebar.
  2. In the System section, click API roles and clients.
  3. Click the APl Clients tab at the top of the pane.
  4. Click New .
  5. Enter a display name for the API client.
  6. In the API Roles field, add the roles you want to assign to the client.

    The client will have the cumulative privileges of all assigned roles.

  7. Under Access Token Lifetime, enter the time in seconds that you want access tokens to be valid for.
    Note:

    Changing the Access Token Lifetime value at a later time does not affect any access tokens previously generated from the API client. Similarly, deleting or disabling a client does not disallow access for previously generated access tokens that are still valid. Changes made to any API roles assigned to a client, however, will affect all access tokens immediately.

  8. Click Save .
  9. Click Edit .
  10. Click Enable API Client to allow the client to be used to generate a client secret.
  11. Click Save .