Create an API account in Apple School Manager
Overview
With the Apple School Manager API, you can edit the devices’ management assignments and view device information. You can also use a device’s endpoint to give apps the ability to create custom reports or to export device data. The 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 APIs, you need to create an API account in Apple School Manager. Only users with the role of Administrator and Site Manager can create an API account.
Note: You can have up to 50 API accounts.
Data access
When the 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 device management services. | Assign or unassign devices to a device management service. |
Generate a private key
To maintain a secure connection to Apple School Manager, you need to generate a private key. The key’s filename ends in .pem, and you generate it only once.
Create a new API account and download the private key
In Apple School Manager
, sign in with a user who has the role of Administrator or Site Manager.Select your name at the bottom of the sidebar, select Preferences
, then select API.Select Get Started, enter a name for the account, then select Create.
Choose one of the following:
Select Generate Private Key to generate 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 Later to generate the private key later.
Select Manage to view the information you need to create the connection.
Review the Apple Developer documentation on how to create the connection.