Skip to main content
Requires Jamf Pro 10.49.0 or later. You must be a Jamf Pro administrator of the tenant.

​
Create an API Role

An API Role groups one or more Jamf Pro privileges (e.g. “Read Computers”, “Update Mobile Devices”) that the API Client will be allowed to exercise.

1

Create the role

Sign in as a Jamf Pro administrator at https://<your-tenant>.jamfcloud.com (Jamf Cloud) or your self-hosted Jamf Pro URL, then go to Settings > System > API Roles and Clients and open the API Roles tab.

  • Click + New.
  • Display Name: StackOne Integration
2

Select the privileges

Enables actions: Add Computer Prestage Scope, Add Mobile Device Prestage Scope, Create App Installer Deployment, Create Building, Create Category, Create Department, Create MDM Command, Create Mobile Device Smart Group, Create Mobile Device Static Group, Create Policy, Create Printer, Create Script, Create Smart Computer Group, Create Static Computer Group, Create User, Delete Building, Delete Category, Delete Computer, Delete Department, Delete Policy, Delete Script, Delete Smart Computer Group, Delete Static Computer Group, Delete User, Erase Mobile Device, Find MacOS Configuration Profiles, Find Mobile Device Configuration Profiles, Find Policies, Find Policies By Category, Find Policy, Get App Installer Deployment, Get App Installer Title, Get Building, Get Categories, Get Category, Get Computer, Get Computer Detail, Get Computer Extension Attribute, Get Computer FileVault, Get Computer Prestage, Get Computer Prestage Scope, Get Computers, Get Department, Get MDM Commands, Get Mac Application, Get MacOS Configuration Profile, Get Mobile Device, Get Mobile Device Application, Get Mobile Device Configuration Profile, Get Mobile Device Detail, Get Mobile Device Extension Attribute, Get Mobile Device Prestage, Get Mobile Device Prestage Scope, Get Mobile Device Smart Group, Get Mobile Device Smart Groups, Get Mobile Device Static Group, Get Mobile Device Static Groups, Get Mobile Devices, Get Package, Get Patch Software Title Configuration, Get Printer, Get Restricted Software, Get Script, Get Smart Computer Group, Get Static Computer Group, Get Unified Group, Get Unified User, Get User, Get User Extension Attribute, Get Users, List App Installer Deployments, List App Installer Titles, List Computer Extension Attributes, List Computer Prestage Scopes, List Computer Prestages, List Mac Applications, List Mobile Device Applications, List Mobile Device Extension Attributes, List Mobile Device Prestage Scopes, List Mobile Device Prestages, List Packages, List Patch Policies, List Patch Software Title Configurations, List Printers, List Restricted Software, List Unified Groups, List Unified Users, List User Extension Attributes, Remove Computer Prestage Scope, Remove Mobile Device Prestage Scope, Replace Computer Prestage Scope, Replace Mobile Device Prestage Scope, Replace Script, Search Buildings, Search Computer Smart Groups, Search Computer Static Groups, Search Departments, Search Scripts, Update Computer, Update Mobile Device, Update Mobile Device Static Group, Update Policy, Update Printer, Update Static Computer Group, Update Static Computer Group Membership, Update User

Add each of these privileges to the role.

3

Save the role

Click Save. The role is now available to be assigned to API Clients.

​
Create an API Client

The API Client provides the Client ID and Client Secret.

1

Create the client

From Settings > System > API Roles and Clients, open the API Clients tab.

  • Click + New.
  • Display Name: StackOne
  • API Roles: the role you created
  • Access Token Lifetime: how long, in seconds, issued access tokens remain valid
  • Enabled: ON
  • Click Save.
2

Copy the Client ID

The Client ID identifies the API Client.

  • Copy the Client ID (a UUID) across.
3

Generate the Client Secret

The Client Secret authenticates the API Client. Jamf Pro shows it only once.

  • Click Generate Client Secret.
  • Copy the Client Secret across.

​
Find your Jamf Pro URL

Your Jamf Pro URL is the address you use to open the Jamf Pro web console.

  • Format: https://{subdomain}.jamfcloud.com
  • Example: https://acme.jamfcloud.com
  • Self-hosted deployments use their own server URL, such as https://jamf.example.com:8443.
  • Do not add a trailing slash.
1

Connect

  • Click Connect.
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup.
2

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.