The CloudRadial AutomationAI Jamf Pro extension lets a workflow or agent work with the Apple fleet you manage in Jamf Pro: inventory Mac computers and mobile devices, review policies, computer groups, scripts, configuration profiles, and users, and, with approval, update a computer record or send MDM remote commands such as lock, restart, erase, and clear passcode. This article covers what the extension can do, the API client and secrets it needs, which tools require approval, and the skills that ship with it. It is for workspace users who build automations (Admin or Owner Role).
- What the Extension Covers
- Creating the API Client
- Providing the Credentials to Your Runner
- Reads and Approval-Gated Changes
- Skills
- Tips for Working With Jamf Pro Data
What the Extension Covers
The extension calls the Jamf Pro API and provides 17 tools across these areas:
| Area | What you can automate |
| Mac computers | List computer inventory records, choosing which data sections to include, read one computer with all of its details, and update fields on a computer record |
| Mobile devices | List iPhones, iPads, and Apple TVs and read one device's full details |
| Configuration | List policies, computer groups (smart and static), scripts, macOS configuration profiles, and users |
| Lookups | List buildings and departments, and check the Jamf Pro server version to confirm the connection works |
| Remote commands | Send MDM commands such as device lock, restart, erase, and clear passcode to computers and mobile devices, and read MDM command history to confirm a command was delivered or completed |
Install it from Extensions like any other catalog extension. See Browsing and installing extensions for the general install flow.
Creating the API Client
The extension signs in with an OAuth API client, which requires Jamf Pro 10.49 or later. The runner exchanges the client id and secret for a short-lived access token and renews it as needed; you only store the client credentials.
- In Jamf Pro, go to Settings > System > API Roles and Clients.
- On the API Roles tab, create an API role with the privileges the tools you plan to use need. For example, the inventory reads need Read Computers and Read Mobile Devices, the script, building, and department lookups need Read Scripts, Read Buildings, and Read Departments, and MDM commands need View MDM command information in Jamf Pro API. Jamf lists the privilege each endpoint requires in its Privileges and Deprecations reference.
- Create an API client and assign it that role. A client can't be created without at least one role.
- Generate the client secret, then copy the client id and the client secret. Jamf Pro shows the secret only when it is generated and can't show it again, so store it right away. You can rotate the secret later.
Providing the Credentials to Your Runner
Store three secrets in your runner's Key Vault with these exact names:
| Secret | Value |
JamfPro-ApiUrl |
The full base URL of your Jamf Pro instance with no trailing slash, for example https://your-instance.jamfcloud.com. For an on-premises Jamf Pro server, use your own base URL, for example https://jamf.example.com:8443. |
JamfPro-ClientId |
The API client id, a GUID-style string |
JamfPro-ClientSecret |
The matching API client secret |
For how to add secrets, see Accessing and updating your runner's Key Vault. If you run a separate Jamf Pro instance per client, see Managing companies and per-company credentials.
Reads and Approval-Gated Changes
Of the 17 tools, 13 only read data and run without approval. The other four change a record or act on a device, so they pause the run for approval. The request appears as an Action Required item in the Inbox until someone approves it. See Handling Action Required items in the Inbox.
| Tool behavior | Tools |
| Approval-gated | Update a computer record; send an MDM command to one or more devices; send a command to one computer or one mobile device through the older command endpoints, which are kept as a fallback |
| Read-only | Check the server version; list and read computers; list and read mobile devices; list scripts, buildings, departments, policies, computer groups, users, and configuration profiles; read MDM command history |
Erase is destructive, and device lock is high-impact, so confirm the target device before you approve either. Agents are instructed never to send a destructive command without an explicit, confirmed target.
Skills
The extension ships four skills that guide an agent through common Jamf Pro tasks:
| Skill | Use it to |
| Inventory Mac Computers | Find Macs, read a computer's hardware, OS, and security details, or update a computer record, for example to rename it, set its asset tag, or reassign its user or department. The update is approval-gated. |
| Inventory Mobile Devices | Find iOS, iPadOS, and tvOS devices, look one up by id, and read its details and management id. Read-only. |
| Run Device Commands | Lock, restart, erase, or clear the passcode on a Mac or mobile device, or check the status of a command already sent. Every command is approval-gated. |
| Review Policies, Groups and Profiles | Review policies, smart and static computer groups, scripts, macOS configuration profiles, and users. Read-only. |
To give an agent these skills, see Creating custom agents and using them in workflows.
Tips for Working With Jamf Pro Data
- MDM commands target a device by its management id, a UUID on the device's inventory record, not by its numeric Jamf id. The agent reads the device first to get it.
- When you update a computer record, give only the fields you want to change
- The main command tool works for both computers and mobile devices. The older per-device command endpoints are a fallback only; Jamf removed device lock and erase from the older mobile device endpoint in Jamf Pro 11.20.0.
- After sending a command, ask the agent to check MDM command history to confirm it was delivered or completed
- Run the server version check first when you set up the extension. It confirms that the API client and the connection work without changing anything.
If you are still having trouble, we’re here to help! Submit a ticket here for assistance, and don’t forget to check our status page to ensure there are no outages in your area.
Comments
0 comments
Please sign in to leave a comment.