Einen API-Account in Apple Business erstellen
Übersicht
Mit der Apple Business-API kannst du die Verwaltungszuweisungen der Geräte bearbeiten und Geräteinformationen anzeigen. Du kannst auch den Endpunkt eines Geräts verwenden, um Apps zu ermöglichen, benutzerdefinierte Berichte zu erstellen oder Gerätedaten zu exportieren. Die API unterstützt OAuth 2. Mit OAuth 2 authentifizieren sich Apps mit einem Set von Anmeldedaten im Tausch gegen ein Zugriffstoken, um authentifizierte Anfragen an die API zu stellen.
Bevor du diese APIs verwenden kannst, musst du einen API-Account in Apple Business erstellen. Nur Benutzer:innen mit der Rolle „Administrator:in der Organisation“ können einen API-Account erstellen.
Hinweis: Du kannst bis zu 50 API-Accounts haben.
Datenzugriff
Wenn der API-Account korrekt konfiguriert ist, kann er einer App den Zugriff auf die folgenden Informationen erlauben:
Kategorie | Beschreibung |
|---|---|
Geräte | Eine Liste der Geräte in einer Organisation abrufen, die sich mit der automatischen Geräte-Registrierung registrieren. |
Geräte | Informationen über ein Gerät in einer Organisation abrufen, etwa Gerätemodell, Bestellnummer und Teilenummer. |
Geräteverwaltungsdienste | Eine Liste der Geräteverwaltungsdienste in einer Organisation abrufen. |
Geräteverwaltungsdienste | Seriennummern der Geräte abrufen, die einem Geräteverwaltungsdienst zugewiesen sind. |
Geräteverwaltungsdienste | Die ID des zugewiesenen Geräteverwaltungsdiensts für ein Gerät abrufen. |
Geräteverwaltungsdienste | Informationen über den zugewiesenen Geräteverwaltungsdienst für ein Gerät abrufen. |
Geräteverwaltungsdienste | Informationen über die Aktivitäten eines Organisationsgeräts abrufen, die durch eine Geräteverwaltungsaktion generiert werden, etwa durch Zuweisen oder Aufheben der Zuweisung. |
Geräteverwaltungsdienste | Geräte einem Geräteverwaltungsdienst zuweisen oder Zuweisung aufheben. |
Benutzerverwaltungsdienste | Liste der Benutzer:innen in einer Organisation abrufen |
Benutzerverwaltungsdienste | Informationen über eine:n bestimmte:n Benutzer:in in einer Organisation abrufen |
Verwaltungsdienste für Benutzergruppen | Liste der Benutzergruppen in einer Organisation abrufen |
Verwaltungsdienste für Benutzergruppen | Informationen zu einer bestimmten Benutzergruppe in einer Organisation abrufen |
Verwaltungsdienste für Benutzergruppen | Liste der Benutzer:innen abrufen, die einer Benutzergruppe in einer Organisation zugewiesen sind |
Blueprints | Liste der Blueprints in einer Organisation abrufen |
Blueprints | Blueprint in einer Organisation erstellen |
Blueprints | Informationen über einen Blueprint in einer Organisation abrufen |
Blueprints | Blueprint in einer Organisation aktualisieren |
Blueprints | Blueprint in einer Organisation löschen |
Blueprints | Mitglieder eines bestimmten Typs innerhalb eines Blueprints in einer Organisation abrufen oder ändern |
Konfigurationen | Liste der Konfigurationen in einer Organisation abrufen |
Konfigurationen | Details einer Konfiguration in einer Organisation abrufen |
Konfigurationen | Konfiguration in einer Organisation erstellen (vom Typ CUSTOM_SETTING) |
Konfigurationen | Konfiguration in einer Organisation aktualisieren (vom Typ CUSTOM_SETTING) |
Konfigurationen | Konfiguration in einer Organisation löschen |
Pakete | Pakete in einer Organisation abrufen |
Apps | Lizenzierte Apps in einer Organisation abrufen |
Audit-Ereignisse | Liste der Audit-Ereignisse für eine Organisation aufrufen, gefiltert nach verschiedenen Kriterien Ein Audit-Ereignis stellt eine Aktivität innerhalb der Organisation dar, beispielsweise das Hinzufügen oder Entfernen eines Geräts. |
Welche Berechtigungen benötige ich für den Zugriff auf die API-Endpunkte?
Benutzer:innen mit einem API-Account benötigen die folgenden Berechtigungen, um auf die API-Endpunkte zugreifen zu können:
Ressource | Ressourcen-URL und -Berechtigung | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
auditEvents | /v1/auditEvents CAN_ACCESS_AUDIT_EVENTS | ||||||||||
users | /v1/users Implizite Berechtigung(CAN_LOGIN_IN_EE_PORTAL) | ||||||||||
users | /v1/users/<IDENTIFIER> Implizite Berechtigung(CAN_LOGIN_IN_EE_PORTAL) | ||||||||||
userGroups | /v1/usergroups Implizite Berechtigung(CAN_LOGIN_IN_EE_PORTAL) | ||||||||||
userGroups | /v1/usergroups/<IDENTIFIER> Implizite Berechtigung(CAN_LOGIN_IN_EE_PORTAL) | ||||||||||
userGroups | /v1/usergroups/<IDENTIFIER>/relationships/users Implizite Berechtigung(CAN_LOGIN_IN_EE_PORTAL) | ||||||||||
blueprints | /v1/blueprints CAN_VIEW_COLLECTIONS/CAN_MANAGE_COLLECTIONS | ||||||||||
blueprints | /v1/blueprints/<IDENTIFIER> CAN_VIEW_COLLECTIONS/CAN_MANAGE_COLLECTIONS | ||||||||||
blueprints | /v1/blueprints/<IDENTIFIER>/relationships/<resource> CAN_VIEW_COLLECTIONS/CAN_MANAGE_COLLECTIONS | ||||||||||
apps | /v1/apps /v1/apps/<IDENTIFIER> CAN_VIEW_COLLECTIONS/CAN_MANAGE_COLLECTIONS | ||||||||||
packages | /v1/packages /v1/packages/<IDENTIFIER> CAN_VIEW_COLLECTIONS/CAN_MANAGE_COLLECTIONS | ||||||||||
configurations | /v1/configurations /v1/configurations/<IDENTIFIER> CAN_VIEW_CONFIGURATIONS/CAN_MANAGE_CONFIGURATIONS | ||||||||||
mdmDevices | /v1/mdmDevices /v1/mdmDevices/<IDENTIFIER>/details CAN_MANAGE_DEVICES | ||||||||||
Einen privaten Schlüssel generieren
Um eine sichere Verbindung zu Apple Business aufrechtzuerhalten, musst du einen privaten Schlüssel generieren. Der Dateiname des Schlüssels endet auf .pem und du generierst ihn nur ein Mal.
Einen neuen API-Account erstellen und den privaten Schlüssel laden
Melde dich in Apple Business mit einem Benutzeraccount an, der über die Rolle „Administrator:in der Organisation“ verfügt.
Wähle „API-Account hinzufügen“ aus, gib den Benutzernamen ein, wähle die Rolle des:der Benutzer:in aus und wähle anschließend „Weiter“ aus.
Führe einen der folgenden Schritte aus:
Wähle „Generieren und laden“ aus, um den Schlüssel zu generieren und zu laden.
Die Datei wird automatisch an den Speicherort für Datei-Downloads in deinen Browsereinstellungen geladen. Wenn dieser nicht festgelegt ist, fragt das System, wo die Datei gesichert werden soll.
Wähle „Später“ aus, um den privaten Schlüssel später zu erstellen.
Wähle „Bearbeiten“ aus, um die Informationen anzuzeigen, die du zum Herstellen der Verbindung brauchst.
Wie du die Verbindung herstellst, erfährst du in der Apple Developer-Dokumentation.
Einen bestehenden API-Account, der aus Apple Business Manager oder Apple Business Essentials migriert wurde, bearbeiten
Wenn deine Organisation von Apple Business Manager oder Apple Business Essentials zu Apple Business migriert wurde und du bestehende API-Accounts hattest, verfügen diese Accounts jetzt über eine benutzerdefinierte Rolle. Du kannst alle API-Accountinformationen überprüfen und bearbeiten.
Melde dich in Apple Business mit einem Benutzeraccount an, der über die Rolle „Administrator:in der Organisation“ verfügt.
Wähle „Bearbeiten“ neben einem bestehenden API-Account aus.
Führe ggf. einen der folgenden Schritte aus:
Änderung des Account-Namens
Änderung der Rolle
Die benutzerdefinierte Rolle ist „Geräte-API-Manager“. Informationen zur Bearbeitung von Rollen und Berechtigungen findest du in der Einführung in Rollen und Zugriffsrechte.
Kopiere die Client-ID in deine Zwischenablage.
Kopiere die Schlüssel-ID in deine Zwischenablage.
Widerrufe den privaten Schlüssel.
Wähle „Sichern“ aus.
Wie du die Verbindung verwaltest, erfährst du in der Apple Developer-Dokumentation.