Einen API-Account in Apple Business erstellen
Übersicht
Mit der Apple Business‑API kannst du die Verwaltungszuweisung der Geräte bearbeiten, Geräteinformationen anzeigen, Workflows für Gerätezuweisungen automatisieren, Gerätebestandsdaten in Drittanbieter-Plattformen integrieren oder individuelle Dashboards erstellen – Aufgaben, die anderenfalls eine manuelle Navigation im Internetportal erfordern würden. Die API unterstützt OAuth 2. Dadurch 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 | Name des Zugriffrechts | Beschreibung |
|---|---|---|
Geräte | Geräteverwaltungsdienste anzeigen, Standardplattformzuweisung verwalten und Geräte mit Apple Configurator hinzufügen | Eine Liste der Geräte in einer Organisation abrufen, die sich mit der automatischen Geräte-Registrierung registrieren. |
Geräte | Geräteverwaltungsdienste anzeigen, Standardplattformzuweisung verwalten und Geräte mit Apple Configurator hinzufügen | Informationen über ein Gerät in einer Organisation abrufen, etwa Gerätemodell, Bestellnummer und Teilenummer. |
Geräteverwaltungsdienste | Geräteverwaltungsdienste anzeigen, Standardplattformzuweisung verwalten und Geräte mit Apple Configurator hinzufügen | Eine Liste der Geräteverwaltungsdienste in einer Organisation abrufen. |
Geräteverwaltungsdienste | Geräteverwaltungsdienste anzeigen, Standardplattformzuweisung verwalten und Geräte mit Apple Configurator hinzufügen | Seriennummern der Geräte abrufen, die einem Geräteverwaltungsdienst zugewiesen sind. |
Geräteverwaltungsdienste | Geräteverwaltungsdienste anzeigen, Standardplattformzuweisung verwalten und Geräte mit Apple Configurator hinzufügen | Die ID des zugewiesenen Geräteverwaltungsdiensts für ein Gerät abrufen. |
Geräteverwaltungsdienste | Geräteverwaltungsdienste anzeigen, Standardplattformzuweisung verwalten und Geräte mit Apple Configurator hinzufügen | Informationen über den zugewiesenen Geräteverwaltungsdienst für ein Gerät abrufen. |
Geräteverwaltungsdienste | Geräteverwaltungsdienste anzeigen, Standardplattformzuweisung verwalten und Geräte mit Apple Configurator hinzufügen | 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 Geräteverwaltungsdiensten zuweisen | 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 | Blueprints anzeigen | Liste der Blueprints in einer Organisation abrufen |
Blueprints | Blueprints verwalten | Blueprint in einer Organisation erstellen |
Blueprints | Blueprints verwalten | Informationen über einen Blueprint in einer Organisation abrufen |
Blueprints | Blueprints verwalten | Blueprint in einer Organisation aktualisieren |
Blueprints | Blueprints verwalten | Blueprint in einer Organisation löschen |
Blueprints | Blueprints verwalten | Mitglieder eines bestimmten Typs innerhalb eines Blueprints in einer Organisation abrufen oder ändern |
Konfigurationen | Gerätekonfigurationen anzeigen | Liste der Konfigurationen in einer Organisation abrufen |
Konfigurationen | Gerätekonfigurationen anzeigen | Details einer Konfiguration in einer Organisation abrufen |
Konfigurationen | Gerätekonfigurationen erstellen, bearbeiten und löschen | Konfiguration in einer Organisation erstellen (vom Typ CUSTOM_SETTING) |
Konfigurationen | Gerätekonfigurationen erstellen, bearbeiten und löschen | Konfiguration in einer Organisation aktualisieren (vom Typ CUSTOM_SETTING) |
Konfigurationen | Gerätekonfigurationen erstellen, bearbeiten und löschen | Konfiguration in einer Organisation löschen |
Pakete | Geräte mit der integrierten Geräteverwaltung anzeigen und verwalten | Pakete in einer Organisation abrufen |
Apps | Apps anzeigen | Lizenzierte Apps in einer Organisation abrufen |
Audit-Ereignisse | Über die Admin‑API auf Audit-Events zugreifen | 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. |
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 übertragen wurde, bearbeiten
Wenn deine Organisation von Apple Business Manager oder Apple Business Essentials zu Apple Business übertragen 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.