Create an Apple Business API account
Overview
With the Apple Business API, you can edit the devices’ management assignments, view device information, automate device assignment workflows, integrate device inventory data into third-party platforms, or build custom dashboards—tasks that would otherwise require manual web portal navigation. The Apple Business API supports OAuth 2 so apps authenticate with a set of credentials in exchange for an access token to make authenticated requests to the API.
Before you can use these Apple Business APIs, you need to create an Apple Business API account. Only users with the role of Organization Administrator can create that type of account.
Note: You can have up to 50 Apple Business API accounts.
Data access
When the Apple Business API account is properly configured, that account can allow an app to access the following information:
Category | Permission name | Description |
|---|---|---|
Devices | View device management services, manage default platform assignment, and add devices with Apple Configurator. | Get a list of devices in an organization that enroll using Automated Device Enrollment. |
Devices | View device management services, manage default platform assignment, and add devices with Apple Configurator. | Get information about a device in an organization, such as the device model, order number, and part number. |
Device management services | View device management services, manage default platform assignment, and add devices with Apple Configurator. | Get a list of device management services in an organization. |
Device management services | View device management services, manage default platform assignment, and add devices with Apple Configurator. | Get a list of device serial numbers assigned to a device management service. |
Device management services | View device management services, manage default platform assignment, and add devices with Apple Configurator. | Get the assigned device management service ID information for a device. |
Device management services | View device management services, manage default platform assignment, and add devices with Apple Configurator. | Get the assigned device management service information for a device. |
Device management services | View device management services, manage default platform assignment, and add devices with Apple Configurator. | Get information for an organization device activity that a device management action creates, such as assign or unassign. |
Device management services | Assign devices to a device management service. | Assign devices to a device management service. |
Device management services | Unassign or release devices from a device management service. | Unassign or release devices from a device management service. |
Device management services | Schedule, update, and cancel a device management service migration. | Schedule, update, and cancel a device management service migration. |
Device management services | Get the Activation Lock status for a device. | Get the Activation Lock status for a device. |
Users | Get a list of users in an organization. | |
Users | Get information about a specific user in an organization. | |
User Groups | Get a list of user groups in an organization. | |
User Groups | Get information about a specific user group in an organization. | |
User Groups | Get a list of users assigned to a user group in an organization. | |
Organizational units | View organizational units. | Get a list of organizational units in an organization. |
Organizational units | View organizational units. | Get information about a specific organizational unit in an organization. |
Organizational units | View organizational units and view users. | Get a list of user IDs assigned to an organizational unit. |
Blueprints | View Blueprints. | Get a list of Blueprints in an organization. |
Blueprints | Manage Blueprints. | Create a Blueprint in an organization. |
Blueprints | Manage Blueprints. | Get information about a Blueprint in an organization. |
Blueprints | Manage Blueprints. | Update a Blueprint in an organization. |
Blueprints | Manage Blueprints. | Delete a Blueprint in an organization. |
Blueprints | Manage Blueprints. | Get or modify the members of a given type within a Blueprint in an organization. |
Configurations | View device configurations. | Get the list of Configurations in an organization. |
Configurations | View device configurations. | Get the details of a Configuration in an organization. |
Configurations | Create, edit, and delete device configurations. | Create a Configuration in an organization (of type CUSTOM_SETTING). |
Configurations | Create, edit, and delete device configurations. | Update a Configuration in an organization (of type CUSTOM_SETTING). |
Configurations | Create, edit, and delete device configurations. | Delete a Configuration in an organization. |
Packages | View and manage devices using built-in device management. | Get packages in an organization. |
Apps | View Apps. | Get the licensed apps in an organization. |
Audit events | Access audit events using the API. | Retrieve a list of audit events for an organization, filtered by various criteria. An audit event represents an activity within the organization, for example adding or removing a device. For a full list of all audit events, see Get Audit Events on the Apple Developer website. |
Generate a private key
To maintain a secure connection to Apple Business, you need to generate a private key. The key’s filename ends in .pem, and you generate it only once.
Create a new Apple Business API account and download the private key
In Apple Business, sign in with a user who has the role of Organization Administrator.
Select Add API Account, enter the name of the user and select their role, then select Next.
Choose one of the following:
Select Generate & Download to generate and download the key.
The file automatically downloads to the file download location in your browser preferences or, if there isn’t a location, the system asks where to save the file.
Select Not Now to generate the private key later.
Select Edit to view the information you need to create the connection.
Review the Apple Developer documentation on how to create the connection.