Sie können externe Anwendungen zur Verwendung der Kernproduktfunktionalität von Workspace ONE UEM konfigurieren, indem Sie REST APIs in die UEM-Infrastruktur integrieren und die Verbindung erleichtern. Sie können auch eine OAuth-Token-URL auswählen, die Ihrem Datencenter am nächsten ist, um API-Aufrufe zu authentifizieren.

Erste Schritte mit REST APIs

Mithilfe einer vereinfachten REST-Software-Architektur unterstützen die Workspace ONE UEM-REST APIs derzeit mehrere Funktionalitäten, darunter Organisationsgruppen, Konsolen-Management, mobile Anwendungen, mobile Geräte, E-Mails, Benutzerregistrierung, Profile, intelligente Gruppen und Benutzergruppen-Management.

Die Verwendung von REST-basierten APIs bietet Unternehmen mehrere Vorteile, u. a. entfallen Kosten und Zeitaufwand für die interne Entwicklung von Anwendungen. Workspace ONE UEM-REST APIs können jederzeit vollständig in Unternehmensserver, Programme und Prozesse integriert werden. Workspace ONE UEM-REST APIs sind effizienter, können problemlos ausgeführt und einfach an die Unternehmensmarke angepasst werden. Diese APIs sind für Anwendungsentwickler vorgesehen. Dieses Handbuch bietet ein Verständnis von Design und Architektur der API-Bibliothek und erleichtert die benutzerdefinierte Entwicklung und Integration mit Workspace ONE UEM.

Zugreifen auf die API-Dokumentation

Lesen Sie die detaillierte API-Dokumentation, indem Sie zur Workspace ONE UEM-API-Hilfeseite navigieren.

Ersetzen Sie in der Adressleiste Ihres Browsers die Datei „cn“ in der URL durch „as“ und hängen Sie dann nach /api/help .com an.

Beispiel: API-Dokumentation für die URL einer SaaS-Umgebung ...
https://cn4855.awmdm.com
...ist ...
https://as4855.awmdm.com/api/help

Datencenter und Token-URLs für OAuth 2.0-Unterstützung

Workspace ONE UEM unterstützt das Standardprotokoll „OAuth 2.0“ für die sichere Authentifizierung und Autorisierung für REST API-Aufrufe.

Workspace ONE Token Service ist der Token-Aussteller für die OAuth-Authentifizierung und wird nur in SaaS-Umgebungen unterstützt. Token-URLs sind regionsspezifisch.

Tabelle 1. Regionsspezifische Token-URLs
Region Workspace ONE UEM SaaS-Datencenter-Standort Token-URL
Ohio (USA) Reine UAT-Umgebung https://uat.uemauth.vmwservices.com/connect/token
Virginia (USA) USA https://na.uemauth.vmwservices.com/connect/token
Virginia (USA) Kanada https://na.uemauth.vmwservices.com/connect/token
Frankfurt (Deutschland) Großbritannien https://emea.uemauth.vmwservices.com/connect/token
Frankfurt (Deutschland) Deutschland https://emea.uemauth.vmwservices.com/connect/token
Tokio (Japan) Indien https://apac.uemauth.vmwservices.com/connect/token
Tokio (Japan) Japan https://apac.uemauth.vmwservices.com/connect/token
Tokio (Japan) Singapur https://apac.uemauth.vmwservices.com/connect/token
Tokio (Japan) Australien https://apac.uemauth.vmwservices.com/connect/token
Tokio (Japan) Hongkong, China https://apac.uemauth.vmwservices.com/connect/token

Erstellen eines OAuth-Clients für API-Befehle (SaaS)

Sie können einen OAuth-Client für API-Befehle erstellen, der nur in SaaS-Umgebungen unterstützt wird. Erstellen Sie einen OAuth-Client für Ihre SaaS-Umgebung, indem Sie die folgenden Schritte ausführen.

  1. Navigieren Sie zu Gruppen und Einstellungen > Konfigurationen.
  2. Geben Sie in das Suchtextfeld mit der Bezeichnung „Name oder Kategorie eingeben“ OAuth ein.
  3. Wählen Sie aus den angezeigten Ergebnissen OAuth Client-Verwaltung aus. Der OAuth Client-Verwaltung-Bildschirm wird angezeigt.
  4. Klicken Sie auf die Schaltfläche Hinzufügen.
  5. Geben Sie Name, Beschreibung, Organisationsgruppe und Rolle ein.
    Hinweis: Weitere Informationen zu bestimmten REST API-Berechtigungen für die ausgewählte Rolle finden Sie in diesem Artikel im Abschnitt mit dem Titel Erstellen einer Rolle, die REST APIs verwenden kann.
  6. Stellen Sie sicher, dass der Status Aktiviert ist.
  7. Wählen Sie Speichern.
  8. WICHTIG: Kopieren Sie die Client-ID und das Client-Geheimnis in die Zwischenablage und speichern Sie sie, bevor Sie diesen Bildschirm schließen. Wählen Sie das Symbol für die Zwischenablage () aus, um das Client-Geheimnis in die Zwischenablage zu kopieren.

    Nachdem Sie Schließen wählen, können Sie nicht hierher zurückkehren, um diese Informationen abzurufen.

  9. Verwenden Sie die Client-ID, den geheimen Client-Schlüssel und die Token-URL, um das Zugriffstoken im folgenden Format zu generieren:

    API-Aufruf: POST {Region-Specific Token URL from section above}

    Schlüssel Wert
    grant_type client_credentials
    client_id {In UEM-Konsole generierte CLIENT-ID}
    client_secret {In UEM-Konsole generierte CLIENT-SECRET}
  10. Verwenden Sie das zurückgegebene Zugriffstoken, um zukünftige API-Anforderungen an Workspace ONE UEM-API-Server zu autorisieren. Sie müssen das Zugriffstoken in den Anforderungsheadern wie folgt formatieren.

    API-Aufruf: {UEM API}

    Schlüssel Wert
    Autorisierung [Zugriffstoken}

Erstellen einer Rolle, die REST APIs verwenden kann

Zu jedem API-Aufruf gehört eine entsprechende Ressource (oder Berechtigung), die Sie in die Rolle aufnehmen müssen, die Sie dem OAuth-Client zuweisen. Die Berechtigungen, die in die von Ihnen zugewiesene Rolle aufgenommen werden sollen, passen also zu den Arten von API-Aufrufen, die Sie durchführen.

Verwenden Sie die Informationen in der folgenden Tabelle, um auszuwählen, welche Berechtigungen Sie in die von Ihnen zugewiesene Rolle aufnehmen müssen. Besuchen Sie dann Administratorrolle erstellen für Anweisungen zur Erstellung dieser Rolle.
Tabelle 2. REST API Role Permissions
Kategorie Name Beschreibung Nur lesen/Bearbeiten
REST > Administratoren REST API System Groups Zugriff auf Organisationsgruppeninformationen Bearbeiten
REST API System Admin Zugriff auf Administratorinformationen Bearbeiten
REST API System Users Zugriff auf Benutzerinformationen Bearbeiten
REST API Admins Write Ermöglicht den Zugriff auf alle Schreib-/Update-APIs in der Admin-Benutzersammlung Bearbeiten
REST API Admins Execute Ermöglicht den Zugriff auf alle Ausführungs-APIs in der Admin-Benutzersammlung Bearbeiten
REST API Admins Delete Ermöglicht den Zugriff auf alle Lösch-APIs in der Admin-Benutzersammlung Bearbeiten
REST API Admins Read Ermöglicht den Zugriff auf alle SCHREIBGESCHÜTZTEN APIs in der Admin-Benutzersammlung Schreibgeschützt
REST > Apps REST API MAM Blob Download-Inhalte hochladen Bearbeiten
REST API MAM Apps Zugriff auf verwaltete Apps Bearbeiten
REST API Apps Write Ermöglicht den Zugriff auf alle Schreib-/Update-APIs in der Apps-Sammlung Bearbeiten
REST API Apps Execute Ermöglicht den Zugriff auf alle Ausführungs-APIs in der Apps-Sammlung Bearbeiten
REST API Apps Delete Ermöglicht den Zugriff auf alle Lösch-APIs in der App-Sammlung Bearbeiten
REST API Apps Read Ermöglicht den Zugriff auf alle SCHREIBGESCHÜTZTEN APIs in der App-Sammlung Schreibgeschützt
REST > Konformitätsrichtlinie REST API Compliance Policy Delete Ermöglicht den Zugriff auf alle Lösch-APIs in der Konformitätsrichtliniensammlung Bearbeiten
REST API Compliance Policy Execute Ermöglicht den Zugriff auf alle Ausführungs-APIs in der Konformitätsrichtliniensammlung Bearbeiten
REST API Compliance Policy Write Ermöglicht den Zugriff auf alle Schreib-APIs in der Konformitätsrichtliniensammlung Bearbeiten
REST API Compliance Policy Read Ermöglicht den Zugriff auf alle SCHREIBGESCHÜTZTEN APIs in der Konformitätsrichtliniensammlung Schreibgeschützt
REST > Benutzerdefinierte Attribute REST API Custom Attributes Execute Ermöglicht den Zugriff auf alle Ausführungs-APIs in der Sammlung benutzerdefinierter Attribute Bearbeiten
REST API Custom Attributes Write Ermöglicht den Zugriff auf alle Schreib-APIs in der Sammlung benutzerdefinierter Attribute Bearbeiten
REST API Custom Attributes Delete Ermöglicht den Zugriff auf alle Lösch-APIs in der Sammlung benutzerdefinierter Attribute Bearbeiten
REST API Custom Attributes Read Ermöglicht den Zugriff auf alle SCHREIBGESCHÜTZTEN APIs in der Sammlung benutzerdefinierter Attribute Schreibgeschützt
REST > Geräte REST API MDM Smart Groups Zugriff auf Informationen zu Smartgroups Bearbeiten
REST API MDM User Groups Zugriff auf Benutzergruppen Bearbeiten
REST API MDM Profiles Sperr-/Entsperrbefehle senden Bearbeiten
REST API MDM Devices Sperr-/Entsperrbefehle senden Bearbeiten
REST API BLOBS Write Ermöglicht den Zugriff auf alle APIs in der BLOBS-Sammlung, die nur zum Schreiben/Aktualisieren bestimmt sind Bearbeiten
REST API BLOBS Execute Ermöglicht den Zugriff auf alle APIs in der BLOBS-Sammlung, die nur zum Ausführen bestimmt sind Bearbeiten
REST API BLOBS Delete Ermöglicht den Zugriff auf alle APIs in der BLOBS-Sammlung, die nur zum Löschen bestimmt sind Bearbeiten
REST API Devices Write Ermöglicht den Zugriff auf alle Schreib-/Update-APIs in der Gerätesammlung Bearbeiten
REST API Devices Execute Ermöglicht den Zugriff auf alle Ausführungs-APIs in der Gerätesammlung Bearbeiten
REST API Devices Delete Ermöglicht den Zugriff auf alle Delete-APIs in der Devices-Sammlung Bearbeiten
REST API Devices Advanced Ermöglicht den Zugriff auf alle erweiterten APIs in der Gerätesammlung Bearbeiten
REST API BLOBS Read Ermöglicht den Zugriff auf alle schreibgeschützten APIs in der BLOBS-Sammlung Schreibgeschützt
REST API Devices Read Ermöglicht den Zugriff auf alle SCHREIBGESCHÜTZTEN APIs in der Gerätesammlung Schreibgeschützt
REST > REST Enterprise Integration REST API Enterprise Integration Read Ermöglicht den Zugriff auf alle SCHREIBGESCHÜTZTEN APIs in Enterprise Integration Schreibgeschützt
REST > Gruppen REST API Groups Write Ermöglicht den Zugriff auf alle Schreib-/Update-APIs in der Organisationsgruppensammlung Bearbeiten
REST API Groups Execute Ermöglicht den Zugriff auf alle Ausführungs-APIs in der Organisationsgruppensammlung Bearbeiten
REST API Groups Delete Ermöglicht den Zugriff auf alle Lösch-APIs in der Organisationsgruppensammlung Bearbeiten
REST API Smart Groups Write Ermöglicht den Zugriff auf alle Schreib-APIs in der Smartgroup-Sammlung Bearbeiten
REST API Smart Groups Execute Ermöglicht den Zugriff auf alle Ausführungs-APIs in Smartgroup-Sammlungen Bearbeiten
REST API Smart Groups Delete Ermöglicht den Zugriff auf alle Lösch-APIs in der Smartgroup-Sammlung Bearbeiten
REST API User Groups Write Ermöglicht den Zugriff auf alle Schreib-/Update-APIs in Benutzergruppen Bearbeiten
REST API User Groups Execute Ermöglicht den Zugriff auf alle ausgeführten APIs in Benutzergruppen Bearbeiten
REST API User Groups Delete Ermöglicht den Zugriff auf alle Lösch-APIs in Benutzergruppen Bearbeiten
REST API Cart Write REST API zum Speichern und Bearbeiten von Warenkorbdaten Bearbeiten
REST API Cart Delete REST API zum Löschen von Warenkorbdaten Bearbeiten
REST API Apple School Manager Write REST API zum Initiieren der Synchronisierung mit Apple School Manager Bearbeiten
REST API Apple School Manager map REST API zum Zuordnen eines Registrierungsbenutzers zu einem Mitglied über Apple School Manager Bearbeiten
REST API Class Assignments Save REST API-Aufruf zum Speichern von Klassenzuweisungen Bearbeiten
REST API Class Write REST API zum Speichern und Bearbeiten von Klassendaten Bearbeiten
REST API Class Delete REST API zum Löschen von Klassendaten Bearbeiten
REST API Education settings Write REST API zum Speichern und Bearbeiten von Bildungseinstellungen Bearbeiten
REST API Education settings Read REST API zum Anzeigen von Bildungseinstellungen Bearbeiten
REST API Groups Read Ermöglicht den Zugriff auf alle SCHREIBGESCHÜTZTEN APIs in der Organisationsgruppensammlung Schreibgeschützt
REST API Smart Groups Read Ermöglicht den Zugriff auf alle SCHREIBGESCHÜTZTEN APIs in der Smartgroup-Sammlung Schreibgeschützt
REST API User Groups Read Ermöglicht den Zugriff auf alle SCHREIBGESCHÜTZTEN APIs in Benutzergruppen Schreibgeschützt
REST API Apple School Manager Sync Read REST API zum Überprüfen des Apple School Manager-Synchronisierungsstatus Schreibgeschützt
REST API Apps For Device Read REST API zum Abrufen einer Liste von Apps, die für ein Gerät geeignet sind Schreibgeschützt
REST API Class Read REST API zum Anzeigen von Klassendaten Schreibgeschützt
REST > Produkte REST API Products Execute Ermöglicht den Zugriff auf alle ausgeführten APIs in der Produktsammlung Bearbeiten
REST API Products Write Ermöglicht den Zugriff auf alle Schreib-APIs in der Produktsammlung Bearbeiten
REST API Products Delete Ermöglicht den Zugriff auf alle Lösch-APIs in der Produktsammlung Bearbeiten
REST API Products Read Ermöglicht den Zugriff auf alle SCHREIBGESCHÜTZTEN APIs in der Produktsammlung Schreibgeschützt
REST > Profile Updates Policy Write access Ermöglicht den Zugriff auf alle SCHREIB-APIs in der Aktualisierungsrichtliniensammlung Bearbeiten
Updates Policy Execute access Ermöglicht den Zugriff auf alle AUSFÜHRUNGS-APIs in der Aktualisierungsrichtliniensammlung Bearbeiten
Updates Policy Delete access Ermöglicht den Zugriff auf alle LÖSCH-APIs in der Aktualisierungsrichtliniensammlung Bearbeiten
REST API Profiles Write Ermöglicht den Zugriff auf alle Schreib-APIs in der Profilsammlung Bearbeiten
REST API Profiles Execute Ermöglicht den Zugriff auf alle Ausführungs-APIs in der Profilsammlung Bearbeiten
REST API Profiles Delete Ermöglicht den Zugriff auf alle Lösch-APIs in der Profilsammlung Bearbeiten
Updates Policy Read access Ermöglicht den Zugriff auf alle SCHREIBGESCHÜTZTEN APIs in der Aktualisierungsrichtliniensammlung Schreibgeschützt
REST API Profiles Read Ermöglicht den Zugriff auf alle SCHREIBGESCHÜTZTEN APIs in der Profilsammlung Schreibgeschützt
REST > Benutzer REST API Users Write Ermöglicht den Zugriff auf alle Schreib-/Update-APIs in der Registrierungsbenutzersammlung Bearbeiten
REST API Users Execute Ermöglicht den Zugriff auf alle Ausführungs-APIs in der Registrierungsbenutzersammlung Bearbeiten
REST API Users Delete Ermöglicht den Zugriff auf alle Lösch-APIs in der Registrierungsbenutzersammlung Bearbeiten
REST API User Tokens Read Ermöglicht den Zugriff auf Registrierungsbenutzer-Token für APIs in der Registrierungsbenutzersammlung Schreibgeschützt
REST API Users Read Ermöglicht den Zugriff auf alle SCHREIBGESCHÜTZTEN APIs für die Registrierungsbenutzersammlung Schreibgeschützt