U kunt externe applicaties configureren om de belangrijkste productfunctionaliteit van Workspace ONE UEM te gebruiken door REST API's in de UEM-infrastructuur te integreren, en de connectiviteit te vergemakkelijken. U kunt ook een OAuth-token-URL selecteren die het dichtst bij uw datacentrum ligt om API-aanroepen te verifiëren.

Aan de slag met REST API's

Met de vereenvoudigde REST-softwarearchitectuur, ondersteunen REST API's van Workspace ONE UEM momenteel meerdere functies, zoals het beheer van organisatiegroepen, console, mobiele applicaties, mobiele toestellen, e-mail, inschrijving van gebruikers, profielen, smart groups en gebruikersgroepen.

Het gebruik van REST API's biedt verschillende voordelen voor ondernemingen, zoals de besparing van kosten en tijd die anders worden besteed aan het zelf ontwikkelen van applicaties. REST API's van Workspace ONE UEM zijn volledig functioneel en klaar om te worden geïntegreerd met bedrijfsservers, -programma's en -processen. Daarnaast zijn REST API's van Workspace ONE UEM efficiënter. Ze worden probleemloos uitgevoerd en kunnen makkelijk worden aangepast voor ondernemingen. Deze API's zijn bedoeld voor applicatieontwikkelaars en deze handleiding biedt een inzicht in het ontwerp en de architectuur van de API-bibliotheek om aangepaste ontwikkeling en integratie met Workspace ONE UEM mogelijk te maken.

Documentatie voor API bekijken

U kunt gedetailleerde API-documentatie inkijken door naar de API-helppagina van Workspace ONE UEM te navigeren.

Doe dit in SaaS-omgevingen door de letters 'cn' in uw URL te vervangen door 'as' en vervolgens na .com /api/help toe te voegen.

Bijvoorbeeld: API-documentatie voor de URL van een SaaS-omgeving
https://cn4855.awmdm.com
is
https://as4855.awmdm.com/api/help

Datacentra en token-URL's voor ondersteuning van OAuth 2.0

Workspace ONE UEM ondersteunt het OAuth 2.0 industriestandaardprotocol voor veilige verificatie en autorisatie van REST API-aanroepen.

Workspace ONE Token Service is de tokenuitgever voor OAuth-verificatie en wordt momenteel alleen ondersteund in SaaS-omgevingen. De token-URL's zijn specifiek voor een regio.

Tabel 1. Regiospecifieke token-URL's
Regio Locatie van SaaS-datacentrum voor Workspace ONE UEM Token-URL
Ohio (Verenigde Staten) Omgeving met alleen UAT https://uat.uemauth.vmwservices.com/connect/token
Virginia (Verenigde Staten) Verenigde Staten https://na.uemauth.vmwservices.com/connect/token
Virginia (Verenigde Staten) Canada https://na.uemauth.vmwservices.com/connect/token
Frankfurt (Duitsland) Verenigd Koninkrijk https://emea.uemauth.vmwservices.com/connect/token
Frankfurt (Duitsland) Duitsland https://emea.uemauth.vmwservices.com/connect/token
Tokio (Japan) India https://apac.uemauth.vmwservices.com/connect/token
Tokio (Japan) Japan https://apac.uemauth.vmwservices.com/connect/token
Tokio (Japan) Singapore https://apac.uemauth.vmwservices.com/connect/token
Tokio (Japan) Australië https://apac.uemauth.vmwservices.com/connect/token
Tokio (Japan) Hong Kong https://apac.uemauth.vmwservices.com/connect/token

Een OAuth-client maken voor gebruik voor API-commando's (SaaS)

U kunt een OAuth-client maken voor gebruik voor API-commando's, die alleen wordt ondersteund in SaaS-omgevingen. Maak een OAuth-client voor uw SaaS-omgeving door de volgende stappen uit te voeren.

  1. Navigeer naar Groepen en instellingen > Configuraties.
  2. Typ OAuth in het zoekvak met de tekst Voer een naam of categorie in.
  3. Selecteer de optie OAuth-clientbeheer die in de resultaten wordt weergegeven. Het scherm OAuth-clientbeheer wordt weergegeven.
  4. Klik op de knop Toevoegen.
  5. Voer de Naam, Omschrijving, Organisatiegroep en Rol in.
    Opmerking: Voor meer informatie over specifieke REST API rechten voor de rol die u selecteert, raadpleegt u de sectie in dit onderwerp Een rol maken die REST API's kan gebruiken.
  6. Zorg ervoor dat de Status is Ingeschakeld.
  7. Selecteer Opslaan.
  8. BELANGRIJK: Kopieer de Client-ID en het Clientgeheim naar het klembord en sla deze op voordat u dit scherm sluit. Selecteer het pictogram Klembord () om het Clientgeheim op het klembord te zetten.

    U kunt hier niet terugkeren om deze informatie op te halen nadat u Sluiten hebt geselecteerd.

  9. Gebruik de client-ID, het clientgeheim en de token-URL om het toegangstoken in de volgende indeling te genereren:

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

    Sleutel Waarde
    grant_type client_credentials
    client_id {CLIENT-ID gegenereerd op UEM console}
    client_secret {CLIENTGEHEIM gegenereerd op UEM console}
  10. Gebruik het toegangstoken dat u wilt gebruiken om toekomstige API-aanroepen naar Workspace ONE UEM API-servers te autoriseren. Het toegangstoken moet in de volgende indeling worden opgegeven in de aanvraagheader.

    API-aanroep: {UEM API}

    Sleutel Waarde
    Autorisatie [Access Token}

Een rol maken die REST API's kan gebruiken

Elke API-aanroep die u van plan bent te maken, heeft een bijbehorende bron (of recht) die u moet opnemen in de rol die u aan de OAuth-client toewijst. De op te nemen rechten in de rol die u toewijst aan de komen overeen met de soorten API-aanroepen die u uitvoert.

Gebruik de informatie in de volgende tabel om u te helpen bij het selecteren van de rechten die u moet opnemen in de rol die u toewijst. Ga dan naar Beheerdersrollen voor instructies over het maken van die rol.
Tabel 2. REST API rolrechten
Categorie Naam Beschrijving Alleen-lezen/ bewerken
REST > beheerders REST API systeemgroepen Toegang tot informatie over organisatiegroep Bewerken
REST API systeembeheerder Toegang tot beheerdersinformatie Bewerken
REST API systeemgebruikers Toegang tot gebruikersinformatie Bewerken
REST API voor schrijven door beheerders Geeft toegang tot alle schrijf/update-API's in de verzameling beheerder-gebruikers Bewerken
REST API voor uitvoeren door beheerders Geeft toegang tot alle uitvoer-API's in de verzameling beheerder-gebruikers Bewerken
REST API voor verwijderen door beheerders Geeft toegang tot alle verwijder-API's in de verzameling beheerder-gebruikers Bewerken
REST API voor lezen door beheerders Geeft toegang tot alle alleen-lezen-API's in de verzameling beheerder-gebruikers Alleen lezen
REST > Apps REST API MAM-blob Upload download inhoud Bewerken
REST API MAM-applicaties Toegang tot beheerde applicaties Bewerken
REST API schrijven door apps Geeft toegang tot alle schrijf/update-API's in de verzameling apps Bewerken
REST API uitvoeren door apps Geeft toegang tot alle uitvoer-API's in de verzameling apps Bewerken
REST API verwijderen door apps Geeft toegang tot alle verwijder-API's in de verzameling apps Bewerken
REST API lezen door apps Geeft toegang tot alle alleen-lezen-API's in de verzameling apps Alleen lezen
REST > Netwerkbeleid REST API netwerkbeleid verwijderen Geeft toegang tot alle verwijder-API's in de verzameling netwerkbeleid Bewerken
REST API netwerkbeleid uitvoeren Geeft toegang tot alle uitvoer-API's in de verzameling netwerkbeleid Bewerken
REST API netwerkbeleid schrijven Geeft toegang tot alle schrijf-API's in de verzameling van netwerkbeleid Bewerken
REST API netwerkbeleid lezen Geeft toegang tot alle alleen-lezen-API's in de verzameling netwerkbeleid Alleen lezen
REST > Aangepaste eigenschappen REST API aangepaste eigenschappen uitvoeren Geeft toegang tot alle uitvoer-API's in de verzameling aangepaste eigenschappen Bewerken
REST API aangepaste eigenschappen schrijven Geeft toegang tot alle schrijf-API's in de verzameling aangepaste eigenschappen Bewerken
REST API aangepaste eigenschappen verwijderen Geeft toegang tot alle verwijder-API's in de verzameling aangepaste eigenschappen Bewerken
REST API aangepaste eigenschappen lezen Geeft toegang tot alle alleen-lezen-API's in de verzameling aangepaste eigenschappen Alleen lezen
REST > Toestellen REST API MDM Smart Groups Toegang tot smart group-informatie Bewerken
REST API MDM-gebruikersgroepen Toegang tot gebruikersgroepen Bewerken
REST API MDM-profielen Commando's voor vergrendeling/ontgrendeling verzenden Bewerken
REST API MDM-apparaten Commando's voor vergrendeling/ontgrendeling verzenden Bewerken
REST API BLOBS schrijven Geeft toegang tot alle alleen-schrijf/update-API's in de verzameling BLOBS Bewerken
REST API BLOBS uitvoeren Geeft toegang tot alle alleen-uitvoeren-API's in de verzameling BLOBS Bewerken
REST API BLOBS verwijderen Geeft toegang tot alle alleen-verwijderen-API's in BLOBS-verzameling Bewerken
REST API voor schrijven door toestellen Geeft toegang tot alle schrijf/update-API's in de verzameling toestellen Bewerken
REST API voor uitvoeren door toestellen Geeft toegang tot alle uitvoer-API's in de verzameling toestellen Bewerken
REST API voor verwijderen door toestellen Geeft toegang tot alle verwijder-API's in de verzameling toestellen Bewerken
REST API geavanceerde apparaten Geeft toegang tot alle geavanceerde API's in de verzameling toestellen Bewerken
REST API BLOBS Lezen Geeft toegang tot alle alleen-lezen-API's in de verzameling BLOBS Alleen lezen
REST API voor lezen door toestellen Geeft toegang tot alle alleen-lezen-API's in de verzameling toestellen Alleen lezen
REST > REST bedrijfsintegratie REST API bedrijfsintegratie lezen Geeft toegang tot alle alleen-lezen-API's in bedrijfsintegratie Alleen lezen
REST > Groepen REST API voor schrijven door groepen Geeft toegang tot alle schrijf/update-API's in de verzameling van organisatiegroep Bewerken
REST API voor uitvoeren door groepen Geeft toegang tot alle uitvoer-API's in de verzameling organisatiegroep Bewerken
REST API voor verwijderen door groepen Geeft toegang tot alle verwijder-API's in de verzameling organisatiegroep Bewerken
REST API voor schrijven door Smart Groups Geeft toegang tot alle schrijf-API's in de verzameling Smart Groups Bewerken
REST API voor uitvoeren door Smart Groups Geeft toegang tot alle uitvoer-API's in de verzameling Smart Groups Bewerken
REST API voor verwijderen door Smart Groups Geeft toegang tot alle verwijder-API's in de verzameling Smart Groups Bewerken
REST API voor schrijven door gebruikersgroepen Geeft toegang tot alle schrijf/update-API's in gebruikersgroepen Bewerken
REST API voor uitvoeren door gebruikersgroepen Geeft toegang tot alle uitvoer-API's in gebruikersgroepen Bewerken
REST API voor verwijderen door gebruikersgroepen Geeft toegang tot alle verwijder-API's in gebruikersgroepen Bewerken
REST API voor schrijven naar winkelwagen REST API om winkelwagengegevens op te slaan en te bewerken Bewerken
REST API voor leegmaken van winkelwagen REST API om winkelwagengegevens te verwijderen Bewerken
REST API Apple School Manager schrijven REST API om Apple School Manager-synchronisatie te starten Bewerken
REST API Apple School Manager kaart REST API om een inschrijvingsgebruiker toe te wijzen aan een lid van Apple School Manager Bewerken
REST API klassetoewijzingen opslaan REST API aanroep om klassetoewijzingen op te slaan Bewerken
REST API klasse schrijven REST API om klassegegevens op te slaan en te bewerken Bewerken
REST API klasse verwijderen REST API om klassegegevens te verwijderen Bewerken
REST API onderwijsinstellingen schrijven REST API om onderwijsinstellingen op te slaan en te bewerken Bewerken
REST API onderwijsinstellingen lezen REST API om onderwijsinstellingen te bekijken Bewerken
REST API groepen lezen Geeft toegang tot alle alleen-lezen-API's in de verzameling organisatiegroep Alleen lezen
REST API Smart Groups lezen Geeft toegang tot alle alleen-lezen-API's in de verzameling Slimme groepen Alleen lezen
REST API gebruikersgroepen lezen Geeft toegang tot alle alleen-lezen-API's in gebruikersgroepen Alleen lezen
REST API Apple School Manager sync lezen REST API om de synchronisatiestatus van Apple School Manager te controleren Alleen lezen
REST API apps voor toestel lezen REST API om een lijst te verkrijgen van apps die in aanmerking komen voor een toestel Alleen lezen
REST API klasse lezen REST API om klassegegevens weer te geven Alleen lezen
REST > Producten REST API producten uitvoeren Geeft toegang tot alle uitvoer-API's in de verzameling producten Bewerken
REST API producten schrijven Geeft toegang tot alle schrijf-API's in de verzameling producten Bewerken
REST API producten verwijderen Geeft toegang tot alle verwijder-API's in de verzameling producten Bewerken
REST API producten Lezen Geeft toegang tot alle alleen-lezen-API's in de verzameling producten Alleen lezen
REST > Profielen Beleid voor updates schrijftoegang Geeft toegang tot alle schrijf-API's in de verzameling beleid voor updates Bewerken
Beleid voor updates uitvoeringstoegang Geeft toegang tot alle verwijder-API's in de verzameling beleid voor updates Bewerken
Beleid voor updates verwijderingstoegang Geeft toegang tot alle verwijder-API's in de verzameling beleid voor updates Bewerken
REST API profielen schrijven Geeft toegang tot alle schrijf-API's in de verzameling profielen Bewerken
REST API profielen uitvoeren Geeft toegang tot alle uitgevoerde API's in de verzameling profielen Bewerken
REST API profielen verwijderen Geeft toegang tot alle verwijder-API's in de verzameling profielen Bewerken
Beleid voor updates leestoegang Geeft toegang tot alle alleen-lezen-API's in het beleid voor updates Alleen lezen
REST API profielen lezen Geeft toegang tot alle alleen-lezen-API's in de verzameling profielen Alleen lezen
REST > Gebruikers REST API voor schrijven door gebruikers Geeft toegang tot alle schrijf/update-API's in de verzameling inschrijvingsgebruikers Bewerken
REST API voor uitvoeren door gebruikers Geeft toegang tot alle uitvoer-API's in de verzameling inschrijvingsgebruikers Bewerken
REST API voor verwijderen door gebruikers Geeft toegang tot alle verwijder-API's in de verzameling inschrijvingsgebruikers Bewerken
REST API gebruikerstokens lezen Geeft toegang tot inschrijvingsgebruikerstokens voor API's in de verzameling inschrijvingsgebruikers Alleen lezen
REST API voor lezen door gebruikers Geeft toegang tot alle alleen-lezen-API's in de verzameling inschrijvingsgebruikers Alleen lezen