Verwenden von UEM-Funktionalität mit einer REST API

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.

1. Melden Sie sich bei der Workspace ONE UEM Console als Administrator an.
2. 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.

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 & 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. Wählen Sie 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 diese Ansicht verlassen. Wählen Sie das Kopieren-Symbol (), um das Client-Geheimnis in der Zwischenablage abzulegen.

   Nachdem Sie Schließen gewählt haben, können Sie nicht mehr 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:

   HTTP-ANFORDERUNG

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

   EINGABEPARAMETER

   Parameter	Erforderlich	Beschreibung
   tenant_url	Ja (URL)	Hostname Ihres Mandanten
   grant_type=client_credentials	Ja (Textkörper)	Erforderlich, um das Zugriffstoken zu erhalten
   application/x-www-form-urlencoded	Ja (Kopfzeile)	Format der Codierung
   Autorisierung: Standard	Ja (Kopfzeile)	Sie müssen die Base64-codierte Zeichenfolge des client_id:Client_secret übergeben

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	{Access Token}

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. Im Abschnitt mit dem Titel Administratorrolle erstellen unter Rollenbasierter Zugriff finden Sie Anweisungen zum Erstellen dieser Rolle.